Package software.amazon.awscdk.services.cognito

Class CfnUserPoolDomain

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.cognito.CfnUserPoolDomain
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:43.944Z") @Stability(Stable) public class CfnUserPoolDomain extends CfnResource implements IInspectable
A CloudFormation AWS::Cognito::UserPoolDomain.

The AWS::Cognito::UserPoolDomain resource creates a new domain for a user pool.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 CfnUserPoolDomain cfnUserPoolDomain = CfnUserPoolDomain.Builder.create(this, "MyCfnUserPoolDomain")
         .domain("domain")
         .userPoolId("userPoolId")
         // the properties below are optional
         .customDomainConfig(CustomDomainConfigTypeProperty.builder()
                 .certificateArn("certificateArn")
                 .build())
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnUserPoolDomain

      protected CfnUserPoolDomain(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnUserPoolDomain

      protected CfnUserPoolDomain(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnUserPoolDomain

      @Stability(Stable) public CfnUserPoolDomain(@NotNull Construct scope, @NotNull String id, @NotNull CfnUserPoolDomainProps props)
      Create a new AWS::Cognito::UserPoolDomain.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCloudFrontDistribution

      @Stability(Stable) @NotNull public String getAttrCloudFrontDistribution()
      The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDomain

      @Stability(Stable) @NotNull public String getDomain()
      The domain name for the domain that hosts the sign-up and sign-in pages for your application.

      For example: auth.example.com . If you're using a prefix domain, this field denotes the first part of the domain before .auth.[region].amazoncognito.com .

      This string can include only lowercase letters, numbers, and hyphens. Don't use a hyphen for the first or last character. Use periods to separate subdomain names.

    • setDomain

      @Stability(Stable) public void setDomain(@NotNull String value)
      The domain name for the domain that hosts the sign-up and sign-in pages for your application.

      For example: auth.example.com . If you're using a prefix domain, this field denotes the first part of the domain before .auth.[region].amazoncognito.com .

      This string can include only lowercase letters, numbers, and hyphens. Don't use a hyphen for the first or last character. Use periods to separate subdomain names.

    • getUserPoolId

      @Stability(Stable) @NotNull public String getUserPoolId()
      The user pool ID for the user pool where you want to associate a user pool domain.

    • setUserPoolId

      @Stability(Stable) public void setUserPoolId(@NotNull String value)
      The user pool ID for the user pool where you want to associate a user pool domain.

    • getCustomDomainConfig

      @Stability(Stable) @Nullable public Object getCustomDomainConfig()
      The configuration for a custom domain that hosts the sign-up and sign-in pages for your application.

      Use this object to specify an SSL certificate that is managed by ACM.

    • setCustomDomainConfig

      @Stability(Stable) public void setCustomDomainConfig(@Nullable IResolvable value)
      The configuration for a custom domain that hosts the sign-up and sign-in pages for your application.

      Use this object to specify an SSL certificate that is managed by ACM.

    • setCustomDomainConfig

      @Stability(Stable) public void setCustomDomainConfig(@Nullable CfnUserPoolDomain.CustomDomainConfigTypeProperty value)
      The configuration for a custom domain that hosts the sign-up and sign-in pages for your application.

      Use this object to specify an SSL certificate that is managed by ACM.