Interface CfnDomainProps

All Superinterfaces:
All Known Implementing Classes:

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:42.127Z") @Stability(Stable) public interface CfnDomainProps extends
Properties for defining a CfnDomain.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 CfnDomainProps cfnDomainProps = CfnDomainProps.builder()
         // the properties below are optional
  • Method Details

    • getAppId

      @Stability(Stable) @NotNull String getAppId()
      The unique ID for an Amplify app.

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

      Pattern: d[a-z0-9]+

    • getDomainName

      @Stability(Stable) @NotNull String getDomainName()
      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])(.)?$

    • getSubDomainSettings

      @Stability(Stable) @NotNull Object getSubDomainSettings()
      The setting for the subdomain.
    • getAutoSubDomainCreationPatterns

      @Stability(Stable) @Nullable default List<String> getAutoSubDomainCreationPatterns()
      Sets the branch patterns for automatic subdomain creation.
    • getAutoSubDomainIamRole

      @Stability(Stable) @Nullable default String getAutoSubDomainIamRole()
      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.+

    • getEnableAutoSubDomain

      @Stability(Stable) @Nullable default Object getEnableAutoSubDomain()
      Enables the automated creation of subdomains for branches.
    • builder

      @Stability(Stable) static CfnDomainProps.Builder builder()
      a CfnDomainProps.Builder of CfnDomainProps