@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:45.304Z") public class CfnDomain extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnDomain(Construct scope,
java.lang.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) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAppId()
The unique ID for an Amplify app.
|
java.lang.String |
getAttrArn()
ARN for the Domain Association.
|
java.util.List<java.lang.String> |
getAttrAutoSubDomainCreationPatterns()
Branch patterns for the automatically created subdomain.
|
java.lang.String |
getAttrAutoSubDomainIamRole()
The IAM service role for the subdomain.
|
java.lang.String |
getAttrCertificateRecord()
DNS Record for certificate verification.
|
java.lang.String |
getAttrDomainName()
Name of the domain.
|
java.lang.String |
getAttrDomainStatus()
Status for the Domain Association.
|
IResolvable |
getAttrEnableAutoSubDomain()
Specifies whether the automated creation of subdomains for branches is enabled.
|
java.lang.String |
getAttrStatusReason()
Reason for the current status of the domain.
|
java.util.List<java.lang.String> |
getAutoSubDomainCreationPatterns()
Sets the branch patterns for automatic subdomain creation.
|
java.lang.String |
getAutoSubDomainIamRole()
The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDomainName()
The domain name for the domain association.
|
java.lang.Object |
getEnableAutoSubDomain()
Enables the automated creation of subdomains for branches.
|
java.lang.Object |
getSubDomainSettings()
The setting for the subdomain.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setAppId(java.lang.String value)
The unique ID for an Amplify app.
|
void |
setAutoSubDomainCreationPatterns(java.util.List<java.lang.String> value)
Sets the branch patterns for automatic subdomain creation.
|
void |
setAutoSubDomainIamRole(java.lang.String value)
The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
|
void |
setDomainName(java.lang.String value)
The domain name for the domain association.
|
void |
setEnableAutoSubDomain(java.lang.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(java.util.List<java.lang.Object> value)
The setting for the subdomain.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnDomain(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnDomain(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnDomain(Construct scope, java.lang.String id, CfnDomainProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
public java.util.List<java.lang.String> getAttrAutoSubDomainCreationPatterns()
public java.lang.String getAttrAutoSubDomainIamRole()
public java.lang.String getAttrCertificateRecord()
public java.lang.String getAttrDomainName()
public java.lang.String getAttrDomainStatus()
public IResolvable getAttrEnableAutoSubDomain()
public java.lang.String getAttrStatusReason()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getAppId()
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern: d[a-z0-9]+
public void setAppId(java.lang.String value)
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern: d[a-z0-9]+
public java.lang.String getDomainName()
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])(.)?$
public void setDomainName(java.lang.String value)
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])(.)?$
public java.lang.Object getSubDomainSettings()
public void setSubDomainSettings(IResolvable value)
public void setSubDomainSettings(java.util.List<java.lang.Object> value)
public java.util.List<java.lang.String> getAutoSubDomainCreationPatterns()
public void setAutoSubDomainCreationPatterns(java.util.List<java.lang.String> value)
public java.lang.String getAutoSubDomainIamRole()
Length Constraints: Maximum length of 1000.
Pattern: ^$|^arn:aws:iam::\d{12}:role.+
public void setAutoSubDomainIamRole(java.lang.String value)
Length Constraints: Maximum length of 1000.
Pattern: ^$|^arn:aws:iam::\d{12}:role.+
public java.lang.Object getEnableAutoSubDomain()
public void setEnableAutoSubDomain(java.lang.Boolean value)
public void setEnableAutoSubDomain(IResolvable value)