Package software.amazon.awscdk.services.amplify

Class CfnDomainProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • appId

      @Stability(Stable) public CfnDomainProps.Builder appId(String appId)
      Sets the value of CfnDomainProps.getAppId()
      Parameters:
      appId - The unique ID for an Amplify app. This parameter is required.
      Returns:
      this

    • domainName

      @Stability(Stable) public CfnDomainProps.Builder domainName(String domainName)
      Sets the value of CfnDomainProps.getDomainName()
      Parameters:
      domainName - The domain name for the domain association. This parameter is required.
      Returns:
      this

    • subDomainSettings

      @Stability(Stable) public CfnDomainProps.Builder subDomainSettings(IResolvable subDomainSettings)
      Sets the value of CfnDomainProps.getSubDomainSettings()
      Parameters:
      subDomainSettings - The setting for the subdomain. This parameter is required.
      Returns:
      this

    • subDomainSettings

      @Stability(Stable) public CfnDomainProps.Builder subDomainSettings(List<? extends Object> subDomainSettings)
      Sets the value of CfnDomainProps.getSubDomainSettings()
      Parameters:
      subDomainSettings - The setting for the subdomain. This parameter is required.
      Returns:
      this

    • autoSubDomainCreationPatterns

      @Stability(Stable) public CfnDomainProps.Builder autoSubDomainCreationPatterns(List<String> autoSubDomainCreationPatterns)
      Sets the value of CfnDomainProps.getAutoSubDomainCreationPatterns()
      Parameters:
      autoSubDomainCreationPatterns - Sets the branch patterns for automatic subdomain creation.
      Returns:
      this

    • autoSubDomainIamRole

      @Stability(Stable) public CfnDomainProps.Builder autoSubDomainIamRole(String autoSubDomainIamRole)
      Sets the value of CfnDomainProps.getAutoSubDomainIamRole()
      Parameters:
      autoSubDomainIamRole - The required AWS Identity and Access Management (IAMlong) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
      Returns:
      this

    • certificate

      @Stability(Stable) public CfnDomainProps.Builder certificate(IResolvable certificate)
      Sets the value of CfnDomainProps.getCertificate()
      Parameters:
      certificate - Describes the SSL/TLS certificate for the domain association. This can be your own custom certificate or the default certificate that Amplify provisions for you.

      If you are updating your domain to use a different certificate, Certificate points to the new certificate that is being created instead of the current active certificate. Otherwise, Certificate points to the current active certificate.

      Returns:
      this

    • certificate

      @Stability(Stable) public CfnDomainProps.Builder certificate(CfnDomain.CertificateProperty certificate)
      Sets the value of CfnDomainProps.getCertificate()
      Parameters:
      certificate - Describes the SSL/TLS certificate for the domain association. This can be your own custom certificate or the default certificate that Amplify provisions for you.

      If you are updating your domain to use a different certificate, Certificate points to the new certificate that is being created instead of the current active certificate. Otherwise, Certificate points to the current active certificate.

      Returns:
      this

    • certificateSettings

      @Stability(Stable) public CfnDomainProps.Builder certificateSettings(IResolvable certificateSettings)
      Sets the value of CfnDomainProps.getCertificateSettings()
      Parameters:
      certificateSettings - The type of SSL/TLS certificate to use for your custom domain. If you don't specify a certificate type, Amplify uses the default certificate that it provisions and manages for you.
      Returns:
      this

    • certificateSettings

      @Stability(Stable) public CfnDomainProps.Builder certificateSettings(CfnDomain.CertificateSettingsProperty certificateSettings)
      Sets the value of CfnDomainProps.getCertificateSettings()
      Parameters:
      certificateSettings - The type of SSL/TLS certificate to use for your custom domain. If you don't specify a certificate type, Amplify uses the default certificate that it provisions and manages for you.
      Returns:
      this

    • enableAutoSubDomain

      @Stability(Stable) public CfnDomainProps.Builder enableAutoSubDomain(Boolean enableAutoSubDomain)
      Sets the value of CfnDomainProps.getEnableAutoSubDomain()
      Parameters:
      enableAutoSubDomain - Enables the automated creation of subdomains for branches.
      Returns:
      this

    • enableAutoSubDomain

      @Stability(Stable) public CfnDomainProps.Builder enableAutoSubDomain(IResolvable enableAutoSubDomain)
      Sets the value of CfnDomainProps.getEnableAutoSubDomain()
      Parameters:
      enableAutoSubDomain - Enables the automated creation of subdomains for branches.
      Returns:
      this

    • updateStatus

      @Stability(Stable) public CfnDomainProps.Builder updateStatus(String updateStatus)
      Sets the value of CfnDomainProps.getUpdateStatus()
      Parameters:
      updateStatus - 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.
      Returns:
      this

    • build

      @Stability(Stable) public CfnDomainProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnDomainProps>
      Returns:
      a new instance of CfnDomainProps
      Throws:
      NullPointerException - if any required attribute was not provided