Package software.amazon.awscdk.services.cognito

Class CfnUserPoolDomain.Builder

java.lang.Object
software.amazon.awscdk.services.cognito.CfnUserPoolDomain.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnUserPoolDomain>
Enclosing class:
CfnUserPoolDomain
@Stability(Stable) public static final class CfnUserPoolDomain.Builder extends Object implements software.amazon.jsii.Builder<CfnUserPoolDomain>
A fluent builder for CfnUserPoolDomain.

  • Method Details

    • create

      @Stability(Stable) public static CfnUserPoolDomain.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnUserPoolDomain.Builder.

    • domain

      @Stability(Stable) public CfnUserPoolDomain.Builder domain(String domain)
      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.

      Parameters:
      domain - The domain name for the domain that hosts the sign-up and sign-in pages for your application. This parameter is required.
      Returns:
      this

    • userPoolId

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

      Parameters:
      userPoolId - The user pool ID for the user pool where you want to associate a user pool domain. This parameter is required.
      Returns:
      this

    • customDomainConfig

      @Stability(Stable) public CfnUserPoolDomain.Builder customDomainConfig(IResolvable customDomainConfig)
      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.

      Parameters:
      customDomainConfig - The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. This parameter is required.
      Returns:
      this

    • customDomainConfig

      @Stability(Stable) public CfnUserPoolDomain.Builder customDomainConfig(CfnUserPoolDomain.CustomDomainConfigTypeProperty customDomainConfig)
      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.

      Parameters:
      customDomainConfig - The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnUserPoolDomain build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnUserPoolDomain>
      Returns:
      a newly built instance of CfnUserPoolDomain.