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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.035Z")
 @Stability(value=Stable)
public class CfnDomain
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Amplify::Domain`.

The AWS::Amplify::Domain resource allows 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")
         .enableAutoSubDomain(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnDomain.Builder A fluent builder for CfnDomain.
static interface	CfnDomain.SubDomainSettingProperty The SubDomainSetting property type enables you to connect a subdomain (for example, example.exampledomain.com) to a specific branch.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDomain(software.constructs.Construct scope, String id, CfnDomainProps props) Create a new `AWS::Amplify::Domain`.
protected	CfnDomain(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDomain(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAppId() The unique ID for an Amplify app.
String	getAttrArn() ARN for the Domain Association.
List<String>	getAttrAutoSubDomainCreationPatterns() Branch patterns for the automatically created subdomain.
String	getAttrAutoSubDomainIamRole() The IAM service role for the subdomain.
String	getAttrCertificateRecord() DNS Record for certificate verification.
String	getAttrDomainName() Name of the domain.
String	getAttrDomainStatus() Status for the Domain Association.
IResolvable	getAttrEnableAutoSubDomain() Specifies whether the automated creation of subdomains for branches is enabled.
String	getAttrStatusReason() Reason for the current status of the domain.
List<String>	getAutoSubDomainCreationPatterns() Sets the branch patterns for automatic subdomain creation.
String	getAutoSubDomainIamRole() The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
protected Map<String,Object>	getCfnProperties()
String	getDomainName() The domain name for the domain association.
Object	getEnableAutoSubDomain() Enables the automated creation of subdomains for branches.
Object	getSubDomainSettings() The setting for the subdomain.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAppId(String value) The unique ID for an Amplify app.
void	setAutoSubDomainCreationPatterns(List<String> value) Sets the branch patterns for automatic subdomain creation.
void	setAutoSubDomainIamRole(String value) The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
void	setDomainName(String value) The domain name for the domain association.
void	setEnableAutoSubDomain(Boolean value) Enables the automated creation of subdomains for branches.
void	setEnableAutoSubDomain(IResolvable value) Enables the automated creation of subdomains for branches.
void	setSubDomainSettings(IResolvable value) The setting for the subdomain.
void	setSubDomainSettings(List<Object> value) The setting for the subdomain.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDomain

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

CfnDomain

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

CfnDomain

@Stability(value=Stable)
public CfnDomain(@NotNull
                                          software.constructs.Construct scope,
                                          @NotNull
                                          String id,
                                          @NotNull
                                          CfnDomainProps props)

Create a new `AWS::Amplify::Domain`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrArn()

ARN for the Domain Association.

getAttrAutoSubDomainCreationPatterns

@Stability(value=Stable)
 @NotNull
public List<String> getAttrAutoSubDomainCreationPatterns()

Branch patterns for the automatically created subdomain.

getAttrAutoSubDomainIamRole

@Stability(value=Stable)
 @NotNull
public String getAttrAutoSubDomainIamRole()

The IAM service role for the subdomain.

getAttrCertificateRecord

@Stability(value=Stable)
 @NotNull
public String getAttrCertificateRecord()

DNS Record for certificate verification.

getAttrDomainName

@Stability(value=Stable)
 @NotNull
public String getAttrDomainName()

Name of the domain.

getAttrDomainStatus

@Stability(value=Stable)
 @NotNull
public String getAttrDomainStatus()

Status for the Domain Association.

getAttrEnableAutoSubDomain

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrEnableAutoSubDomain()

Specifies whether the automated creation of subdomains for branches is enabled.

getAttrStatusReason

@Stability(value=Stable)
 @NotNull
public String getAttrStatusReason()

Reason for the current status of the domain.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAppId

@Stability(value=Stable)
 @NotNull
public String getAppId()

The unique ID for an Amplify app.

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

Pattern: d[a-z0-9]+

setAppId

@Stability(value=Stable)
public void setAppId(@NotNull
                                              String value)

The unique ID for an Amplify app.

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

Pattern: d[a-z0-9]+

getDomainName

@Stability(value=Stable)
 @NotNull
public 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])(.)?$

setDomainName

@Stability(value=Stable)
public void setDomainName(@NotNull
                                                   String value)

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(value=Stable)
 @NotNull
public Object getSubDomainSettings()

The setting for the subdomain.

setSubDomainSettings

@Stability(value=Stable)
public void setSubDomainSettings(@NotNull
                                                          IResolvable value)

The setting for the subdomain.

setSubDomainSettings

@Stability(value=Stable)
public void setSubDomainSettings(@NotNull
                                                          List<Object> value)

The setting for the subdomain.

getAutoSubDomainCreationPatterns

@Stability(value=Stable)
 @Nullable
public List<String> getAutoSubDomainCreationPatterns()

Sets the branch patterns for automatic subdomain creation.

setAutoSubDomainCreationPatterns

@Stability(value=Stable)
public void setAutoSubDomainCreationPatterns(@Nullable
                                                                      List<String> value)

Sets the branch patterns for automatic subdomain creation.

getAutoSubDomainIamRole

@Stability(value=Stable)
 @Nullable
public 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.+

setAutoSubDomainIamRole

@Stability(value=Stable)
public void setAutoSubDomainIamRole(@Nullable
                                                             String value)

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(value=Stable)
 @Nullable
public Object getEnableAutoSubDomain()

Enables the automated creation of subdomains for branches.

setEnableAutoSubDomain

@Stability(value=Stable)
public void setEnableAutoSubDomain(@Nullable
                                                            Boolean value)

Enables the automated creation of subdomains for branches.

setEnableAutoSubDomain

@Stability(value=Stable)
public void setEnableAutoSubDomain(@Nullable
                                                            IResolvable value)

Enables the automated creation of subdomains for branches.