Class UserPoolDomain

Provides a Cognito User Pool Domain resource.

Example Usage

Amazon Cognito domain

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.Cognito.UserPool("example", new Aws.Cognito.UserPoolArgs
    {
    });
    var main = new Aws.Cognito.UserPoolDomain("main", new Aws.Cognito.UserPoolDomainArgs
    {
        Domain = "example-domain",
        UserPoolId = example.Id,
    });
}

}

Custom Cognito domain

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.Cognito.UserPool("example", new Aws.Cognito.UserPoolArgs
    {
    });
    var main = new Aws.Cognito.UserPoolDomain("main", new Aws.Cognito.UserPoolDomainArgs
    {
        CertificateArn = aws_acm_certificate.Cert.Arn,
        Domain = "example-domain.example.com",
        UserPoolId = example.Id,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

UserPoolDomain

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Cognito

Assembly: Pulumi.Aws.dll

Syntax

public class UserPoolDomain : CustomResource

Constructors

UserPoolDomain(String, UserPoolDomainArgs, CustomResourceOptions)

Create a UserPoolDomain resource with the given unique name, arguments, and options.

Declaration

public UserPoolDomain(string name, UserPoolDomainArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
UserPoolDomainArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AwsAccountId

The AWS account ID for the user pool owner.

Declaration

public Output<string> AwsAccountId { get; }

Property Value

Type	Description
Output<System.String>

CertificateArn

The ARN of an ISSUED ACM certificate in us-east-1 for a custom domain.

Declaration

public Output<string> CertificateArn { get; }

Property Value

Type	Description
Output<System.String>

CloudfrontDistributionArn

The ARN of the CloudFront distribution.

Declaration

public Output<string> CloudfrontDistributionArn { get; }

Property Value

Type	Description
Output<System.String>

Domain

The domain string.

Declaration

public Output<string> Domain { get; }

Property Value

Type	Description
Output<System.String>

S3Bucket

The S3 bucket where the static files for this domain are stored.

Declaration

public Output<string> S3Bucket { get; }

Property Value

Type	Description
Output<System.String>

UserPoolId

The user pool ID.

Declaration

public Output<string> UserPoolId { get; }

Property Value

Type	Description
Output<System.String>

Version

The app version.

Declaration

public Output<string> Version { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, UserPoolDomainState, CustomResourceOptions)

Get an existing UserPoolDomain resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static UserPoolDomain Get(string name, Input<string> id, UserPoolDomainState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
UserPoolDomainState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
UserPoolDomain