Package software.amazon.awscdk.services.amplify

Class CfnDomain

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.amplify.CfnDomain
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.109.0 (build c221850)", date="2025-03-19T18:01:28.294Z") @Stability(Stable) public class CfnDomain extends CfnResource implements IInspectable
Specifies the AWS::Amplify::Domain resource that enables you to connect a custom domain to your app.

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.amplify.*;
 CfnDomain cfnDomain = CfnDomain.Builder.create(this, "MyCfnDomain")
         .appId("appId")
         .domainName("domainName")
         .subDomainSettings(List.of(SubDomainSettingProperty.builder()
                 .branchName("branchName")
                 .prefix("prefix")
                 .build()))
         // the properties below are optional
         .autoSubDomainCreationPatterns(List.of("autoSubDomainCreationPatterns"))
         .autoSubDomainIamRole("autoSubDomainIamRole")
         .certificateSettings(CertificateSettingsProperty.builder()
                 .certificateType("certificateType")
                 .customCertificateArn("customCertificateArn")
                 .build())
         .enableAutoSubDomain(false)
         .build();

See Also:

  • 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

    • CfnDomain

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

    • CfnDomain

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

    • CfnDomain

      @Stability(Stable) public CfnDomain(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDomainProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). 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.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      ARN for the Domain Association.

    • getAttrAutoSubDomainCreationPatterns

      @Stability(Stable) @NotNull public List<String> getAttrAutoSubDomainCreationPatterns()
      Branch patterns for the automatically created subdomain.

    • getAttrAutoSubDomainIamRole

      @Stability(Stable) @NotNull public String getAttrAutoSubDomainIamRole()
      The IAM service role for the subdomain.

    • getAttrCertificate

      @Stability(Stable) @NotNull public IResolvable getAttrCertificate()

    • getAttrCertificateRecord

      @Stability(Stable) @NotNull public String getAttrCertificateRecord()
      DNS Record for certificate verification.

    • getAttrDomainName

      @Stability(Stable) @NotNull public String getAttrDomainName()
      Name of the domain.

    • getAttrDomainStatus

      @Stability(Stable) @NotNull public String getAttrDomainStatus()
      Status for the Domain Association.

    • getAttrEnableAutoSubDomain

      @Stability(Stable) @NotNull public IResolvable getAttrEnableAutoSubDomain()
      Specifies whether the automated creation of subdomains for branches is enabled.

    • getAttrStatusReason

      @Stability(Stable) @NotNull public String getAttrStatusReason()
      Reason for the current status of the domain.

    • getAttrUpdateStatus

      @Stability(Stable) @NotNull public String getAttrUpdateStatus()
      The status of the domain update operation that is currently in progress.

      The following list describes the valid update states.

      • REQUESTING_CERTIFICATE - The certificate is in the process of being updated.
      • PENDING_VERIFICATION - Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certificate.
      • IMPORTING_CUSTOM_CERTIFICATE - Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certificate.
      • PENDING_DEPLOYMENT - Indicates that the subdomain or certificate changes are being propagated.
      • AWAITING_APP_CNAME - Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on Route 53, Amplify handles this for you automatically. For more information about custom domains, see Setting up custom domains in the Amplify Hosting User Guide .
      • UPDATE_COMPLETE - The certificate has been associated with a domain.
      • UPDATE_FAILED - The certificate has failed to be provisioned or associated, and there is no existing active certificate to roll back to.

    • getCfnProperties

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

    • getAppId

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

    • setAppId

      @Stability(Stable) public void setAppId(@NotNull String value)
      The unique ID for an Amplify app.

    • getDomainName

      @Stability(Stable) @NotNull public String getDomainName()
      The domain name for the domain association.

    • setDomainName

      @Stability(Stable) public void setDomainName(@NotNull String value)
      The domain name for the domain association.

    • getSubDomainSettings

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

    • setSubDomainSettings

      @Stability(Stable) public void setSubDomainSettings(@NotNull IResolvable value)
      The setting for the subdomain.

    • setSubDomainSettings

      @Stability(Stable) public void setSubDomainSettings(@NotNull List<Object> value)
      The setting for the subdomain.

    • getAutoSubDomainCreationPatterns

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

    • setAutoSubDomainCreationPatterns

      @Stability(Stable) public void setAutoSubDomainCreationPatterns(@Nullable List<String> value)
      Sets the branch patterns for automatic subdomain creation.

    • getAutoSubDomainIamRole

      @Stability(Stable) @Nullable public String getAutoSubDomainIamRole()
      The required AWS Identity and Access Management (IAMlong) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.

    • setAutoSubDomainIamRole

      @Stability(Stable) public void setAutoSubDomainIamRole(@Nullable String value)
      The required AWS Identity and Access Management (IAMlong) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.

    • getCertificateSettings

      @Stability(Stable) @Nullable public Object getCertificateSettings()
      The type of SSL/TLS certificate to use for your custom domain.

    • setCertificateSettings

      @Stability(Stable) public void setCertificateSettings(@Nullable IResolvable value)
      The type of SSL/TLS certificate to use for your custom domain.

    • setCertificateSettings

      @Stability(Stable) public void setCertificateSettings(@Nullable CfnDomain.CertificateSettingsProperty value)
      The type of SSL/TLS certificate to use for your custom domain.

    • getEnableAutoSubDomain

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

    • setEnableAutoSubDomain

      @Stability(Stable) public void setEnableAutoSubDomain(@Nullable Boolean value)
      Enables the automated creation of subdomains for branches.

    • setEnableAutoSubDomain

      @Stability(Stable) public void setEnableAutoSubDomain(@Nullable IResolvable value)
      Enables the automated creation of subdomains for branches.