Class CfnDomain.Builder

java.lang.Object
software.amazon.awscdk.services.amplify.CfnDomain.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDomain>
Enclosing class:
CfnDomain

@Stability(Stable) public static final class CfnDomain.Builder extends Object implements software.amazon.jsii.Builder<CfnDomain>
A fluent builder for CfnDomain.
  • Method Details

    • create

      @Stability(Stable) public static CfnDomain.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 CfnDomain.Builder.
    • appId

      @Stability(Stable) public CfnDomain.Builder appId(String appId)
      The unique ID for an Amplify app.

      Length Constraints: Minimum length of 1. Maximum length of 20.

      Pattern: d[a-z0-9]+

      Parameters:
      appId - The unique ID for an Amplify app. This parameter is required.
      Returns:
      this
    • domainName

      @Stability(Stable) public CfnDomain.Builder domainName(String domainName)
      The domain name for the domain association.

      Length Constraints: Maximum length of 255.

      Pattern: ^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9]).)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])(.)?$

      Parameters:
      domainName - The domain name for the domain association. This parameter is required.
      Returns:
      this
    • subDomainSettings

      @Stability(Stable) public CfnDomain.Builder subDomainSettings(IResolvable subDomainSettings)
      The setting for the subdomain.

      Parameters:
      subDomainSettings - The setting for the subdomain. This parameter is required.
      Returns:
      this
    • subDomainSettings

      @Stability(Stable) public CfnDomain.Builder subDomainSettings(List<? extends Object> subDomainSettings)
      The setting for the subdomain.

      Parameters:
      subDomainSettings - The setting for the subdomain. This parameter is required.
      Returns:
      this
    • autoSubDomainCreationPatterns

      @Stability(Stable) public CfnDomain.Builder autoSubDomainCreationPatterns(List<String> autoSubDomainCreationPatterns)
      Sets the branch patterns for automatic subdomain creation.

      Parameters:
      autoSubDomainCreationPatterns - Sets the branch patterns for automatic subdomain creation. This parameter is required.
      Returns:
      this
    • autoSubDomainIamRole

      @Stability(Stable) public CfnDomain.Builder autoSubDomainIamRole(String autoSubDomainIamRole)
      The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.

      Length Constraints: Maximum length of 1000.

      Pattern: ^$|^arn:aws:iam::\d{12}:role.+

      Parameters:
      autoSubDomainIamRole - The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains. This parameter is required.
      Returns:
      this
    • enableAutoSubDomain

      @Stability(Stable) public CfnDomain.Builder enableAutoSubDomain(Boolean enableAutoSubDomain)
      Enables the automated creation of subdomains for branches.

      Parameters:
      enableAutoSubDomain - Enables the automated creation of subdomains for branches. This parameter is required.
      Returns:
      this
    • enableAutoSubDomain

      @Stability(Stable) public CfnDomain.Builder enableAutoSubDomain(IResolvable enableAutoSubDomain)
      Enables the automated creation of subdomains for branches.

      Parameters:
      enableAutoSubDomain - Enables the automated creation of subdomains for branches. This parameter is required.
      Returns:
      this
    • build

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