CfnDomain

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.amplify.CfnDomain

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:45.304Z")
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 interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

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

Constructor Summary

Constructors
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)`

Method Summary

All Methods Instance Methods Concrete Methods
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.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.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
```
public CfnDomain(Construct scope,
                 java.lang.String id,
                 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
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrArn
```
public java.lang.String getAttrArn()
```
    ARN for the Domain Association.
  - getAttrAutoSubDomainCreationPatterns
```
public java.util.List<java.lang.String> getAttrAutoSubDomainCreationPatterns()
```
    Branch patterns for the automatically created subdomain.
  - getAttrAutoSubDomainIamRole
```
public java.lang.String getAttrAutoSubDomainIamRole()
```
    The IAM service role for the subdomain.
  - getAttrCertificateRecord
```
public java.lang.String getAttrCertificateRecord()
```
    DNS Record for certificate verification.
  - getAttrDomainName
```
public java.lang.String getAttrDomainName()
```
    Name of the domain.
  - getAttrDomainStatus
```
public java.lang.String getAttrDomainStatus()
```
    Status for the Domain Association.
  - getAttrEnableAutoSubDomain
```
public IResolvable getAttrEnableAutoSubDomain()
```
    Specifies whether the automated creation of subdomains for branches is enabled.
  - getAttrStatusReason
```
public java.lang.String getAttrStatusReason()
```
    Reason for the current status of the domain.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getAppId
```
public java.lang.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
```
public void setAppId(java.lang.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
```
public java.lang.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
```
public void setDomainName(java.lang.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
```
public java.lang.Object getSubDomainSettings()
```
    The setting for the subdomain.
  - setSubDomainSettings
```
public void setSubDomainSettings(IResolvable value)
```
    The setting for the subdomain.
  - setSubDomainSettings
```
public void setSubDomainSettings(java.util.List<java.lang.Object> value)
```
    The setting for the subdomain.
  - getAutoSubDomainCreationPatterns
```
public java.util.List<java.lang.String> getAutoSubDomainCreationPatterns()
```
    Sets the branch patterns for automatic subdomain creation.
  - setAutoSubDomainCreationPatterns
```
public void setAutoSubDomainCreationPatterns(java.util.List<java.lang.String> value)
```
    Sets the branch patterns for automatic subdomain creation.
  - getAutoSubDomainIamRole
```
public java.lang.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
```
public 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.
    Length Constraints: Maximum length of 1000.
    Pattern: ^$|^arn:aws:iam::\d{12}:role.+
  - getEnableAutoSubDomain
```
public java.lang.Object getEnableAutoSubDomain()
```
    Enables the automated creation of subdomains for branches.
  - setEnableAutoSubDomain
```
public void setEnableAutoSubDomain(java.lang.Boolean value)
```
    Enables the automated creation of subdomains for branches.
  - setEnableAutoSubDomain
```
public void setEnableAutoSubDomain(IResolvable value)
```
    Enables the automated creation of subdomains for branches.

Class CfnDomain

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnDomain

CfnDomain

CfnDomain

Method Detail

inspect

renderProperties

getAttrArn

getAttrAutoSubDomainCreationPatterns

getAttrAutoSubDomainIamRole

getAttrCertificateRecord

getAttrDomainName

getAttrDomainStatus

getAttrEnableAutoSubDomain

getAttrStatusReason

getCfnProperties

getAppId

setAppId

getDomainName

setDomainName

getSubDomainSettings

setSubDomainSettings

setSubDomainSettings

getAutoSubDomainCreationPatterns

setAutoSubDomainCreationPatterns

getAutoSubDomainIamRole

setAutoSubDomainIamRole

getEnableAutoSubDomain

setEnableAutoSubDomain

setEnableAutoSubDomain