1. Packages
  2. AWS Native
  3. API Docs
  4. cognito
  5. UserPoolDomain

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi

aws-native.cognito.UserPoolDomain

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi

    Resource Type definition for AWS::Cognito::UserPoolDomain

    Create UserPoolDomain Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new UserPoolDomain(name: string, args: UserPoolDomainArgs, opts?: CustomResourceOptions);
    @overload
    def UserPoolDomain(resource_name: str,
                       args: UserPoolDomainArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def UserPoolDomain(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       domain: Optional[str] = None,
                       user_pool_id: Optional[str] = None,
                       custom_domain_config: Optional[UserPoolDomainCustomDomainConfigTypeArgs] = None)
    func NewUserPoolDomain(ctx *Context, name string, args UserPoolDomainArgs, opts ...ResourceOption) (*UserPoolDomain, error)
    public UserPoolDomain(string name, UserPoolDomainArgs args, CustomResourceOptions? opts = null)
    public UserPoolDomain(String name, UserPoolDomainArgs args)
    public UserPoolDomain(String name, UserPoolDomainArgs args, CustomResourceOptions options)
    
    type: aws-native:cognito:UserPoolDomain
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args UserPoolDomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args UserPoolDomainArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args UserPoolDomainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserPoolDomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserPoolDomainArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const userPoolDomainResource = new aws_native.cognito.UserPoolDomain("userPoolDomainResource", {
        domain: "string",
        userPoolId: "string",
        customDomainConfig: {
            certificateArn: "string",
        },
    });
    
    Coming soon!
    

    UserPoolDomain Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The UserPoolDomain resource accepts the following input properties:

    Outputs

    All input properties are implicitly available as output properties. Additionally, the UserPoolDomain resource produces the following output properties:

    AwsId string
    CloudFrontDistribution string
    Id string
    The provider-assigned unique ID for this managed resource.
    AwsId string
    CloudFrontDistribution string
    Id string
    The provider-assigned unique ID for this managed resource.
    awsId String
    cloudFrontDistribution String
    id String
    The provider-assigned unique ID for this managed resource.
    awsId string
    cloudFrontDistribution string
    id string
    The provider-assigned unique ID for this managed resource.
    aws_id str
    cloud_front_distribution str
    id str
    The provider-assigned unique ID for this managed resource.
    awsId String
    cloudFrontDistribution String
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    UserPoolDomainCustomDomainConfigType, UserPoolDomainCustomDomainConfigTypeArgs

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi