Package software.amazon.awscdk.services.amplify

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 Summary

Modifier and Type	Method	Description
CfnDomain.Builder	appId(String appId)	The unique ID for an Amplify app.
CfnDomain.Builder	autoSubDomainCreationPatterns(List<String> autoSubDomainCreationPatterns)	Sets the branch patterns for automatic subdomain creation.
CfnDomain.Builder	autoSubDomainIamRole(String autoSubDomainIamRole)	The required AWS Identity and Access Management (IAMlong) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
CfnDomain	build()
CfnDomain.Builder	certificate(IResolvable certificate)	Describes the SSL/TLS certificate for the domain association.
CfnDomain.Builder	certificate(CfnDomain.CertificateProperty certificate)	Describes the SSL/TLS certificate for the domain association.
CfnDomain.Builder	certificateSettings(IResolvable certificateSettings)	The type of SSL/TLS certificate to use for your custom domain.
CfnDomain.Builder	certificateSettings(CfnDomain.CertificateSettingsProperty certificateSettings)	The type of SSL/TLS certificate to use for your custom domain.
static CfnDomain.Builder	create(software.constructs.Construct scope, String id)
CfnDomain.Builder	domainName(String domainName)	The domain name for the domain association.
CfnDomain.Builder	enableAutoSubDomain(Boolean enableAutoSubDomain)	Enables the automated creation of subdomains for branches.
CfnDomain.Builder	enableAutoSubDomain(IResolvable enableAutoSubDomain)	Enables the automated creation of subdomains for branches.
CfnDomain.Builder	subDomainSettings(List<? extends Object> subDomainSettings)	The setting for the subdomain.
CfnDomain.Builder	subDomainSettings(IResolvable subDomainSettings)	The setting for the subdomain.
CfnDomain.Builder	updateStatus(String updateStatus)	The status of the domain update operation that is currently in progress.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnDomain.Builder create(software.constructs.Construct scope,
 String id)

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.

Returns:

a new instance of CfnDomain.Builder.

appId

@Stability(Stable)
public CfnDomain.Builder appId(String appId)

The unique ID for an Amplify app.

Parameters:

appId - The unique ID for an Amplify app. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-appid

domainName

@Stability(Stable)
public CfnDomain.Builder domainName(String domainName)

The domain name for the domain association.

Parameters:

domainName - The domain name for the domain association. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-domainname

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-subdomainsettings

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-subdomainsettings

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-autosubdomaincreationpatterns

autoSubDomainIamRole

@Stability(Stable)
public CfnDomain.Builder autoSubDomainIamRole(String autoSubDomainIamRole)

The required AWS Identity and Access Management (IAMlong) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.

Parameters:

autoSubDomainIamRole - The required AWS Identity and Access Management (IAMlong) service role for the Amazon Resource Name (ARN) for automatically creating subdomains. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-autosubdomainiamrole

certificate

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

Parameters:

certificate - Describes the SSL/TLS certificate for the domain association. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-certificate

certificate

@Stability(Stable)
public CfnDomain.Builder certificate(CfnDomain.CertificateProperty 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.

Parameters:

certificate - Describes the SSL/TLS certificate for the domain association. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-certificate

certificateSettings

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

Parameters:

certificateSettings - The type of SSL/TLS certificate to use for your custom domain. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-certificatesettings

certificateSettings

@Stability(Stable)
public CfnDomain.Builder certificateSettings(CfnDomain.CertificateSettingsProperty 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.

Parameters:

certificateSettings - The type of SSL/TLS certificate to use for your custom domain. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-certificatesettings

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-enableautosubdomain

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-enableautosubdomain

updateStatus

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

Parameters:

updateStatus - The status of the domain update operation that is currently in progress. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-updatestatus

build

@Stability(Stable)
public CfnDomain build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnDomain>

Returns:

a newly built instance of CfnDomain.