Class CfnDomain
A CloudFormation AWS::Amplify::Domain
.
Inherited Members
Namespace: Amazon.CDK.AWS.Amplify
Assembly: Amazon.CDK.AWS.Amplify.dll
Syntax (csharp)
public class CfnDomain : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnDomain
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::Amplify::Domain resource allows you to connect a custom domain to your app.
CloudformationResource: AWS::Amplify::Domain
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Amplify;
var cfnDomain = new CfnDomain(this, "MyCfnDomain", new CfnDomainProps {
AppId = "appId",
DomainName = "domainName",
SubDomainSettings = new [] { new SubDomainSettingProperty {
BranchName = "branchName",
Prefix = "prefix"
} },
// the properties below are optional
AutoSubDomainCreationPatterns = new [] { "autoSubDomainCreationPatterns" },
AutoSubDomainIamRole = "autoSubDomainIamRole",
EnableAutoSubDomain = false
});
Synopsis
Constructors
CfnDomain(Construct, String, ICfnDomainProps) | Create a new |
CfnDomain(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDomain(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AppId | The unique ID for an Amplify app. |
AttrArn | ARN for the Domain Association. |
AttrAutoSubDomainCreationPatterns | Branch patterns for the automatically created subdomain. |
AttrAutoSubDomainIamRole | The IAM service role for the subdomain. |
AttrCertificateRecord | DNS Record for certificate verification. |
AttrDomainName | Name of the domain. |
AttrDomainStatus | Status for the Domain Association. |
AttrEnableAutoSubDomain | Specifies whether the automated creation of subdomains for branches is enabled. |
AttrStatusReason | Reason for the current status of the domain. |
AutoSubDomainCreationPatterns | Sets the branch patterns for automatic subdomain creation. |
AutoSubDomainIamRole | The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DomainName | The domain name for the domain association. |
EnableAutoSubDomain | Enables the automated creation of subdomains for branches. |
SubDomainSettings | The setting for the subdomain. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDomain(Construct, String, ICfnDomainProps)
Create a new AWS::Amplify::Domain
.
public CfnDomain(Construct scope, string id, ICfnDomainProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnDomainProps
- resource properties.
CfnDomain(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDomain(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDomain(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDomain(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AppId
The unique ID for an Amplify app.
public virtual string AppId { get; set; }
Property Value
System.String
Remarks
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern: d[a-z0-9]+
AttrArn
ARN for the Domain Association.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrAutoSubDomainCreationPatterns
Branch patterns for the automatically created subdomain.
public virtual string[] AttrAutoSubDomainCreationPatterns { get; }
Property Value
System.String[]
Remarks
CloudformationAttribute: AutoSubDomainCreationPatterns
AttrAutoSubDomainIamRole
The IAM service role for the subdomain.
public virtual string AttrAutoSubDomainIamRole { get; }
Property Value
System.String
Remarks
CloudformationAttribute: AutoSubDomainIAMRole
AttrCertificateRecord
DNS Record for certificate verification.
public virtual string AttrCertificateRecord { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CertificateRecord
AttrDomainName
Name of the domain.
public virtual string AttrDomainName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: DomainName
AttrDomainStatus
Status for the Domain Association.
public virtual string AttrDomainStatus { get; }
Property Value
System.String
Remarks
CloudformationAttribute: DomainStatus
AttrEnableAutoSubDomain
Specifies whether the automated creation of subdomains for branches is enabled.
public virtual IResolvable AttrEnableAutoSubDomain { get; }
Property Value
Remarks
CloudformationAttribute: EnableAutoSubDomain
AttrStatusReason
Reason for the current status of the domain.
public virtual string AttrStatusReason { get; }
Property Value
System.String
Remarks
CloudformationAttribute: StatusReason
AutoSubDomainCreationPatterns
Sets the branch patterns for automatic subdomain creation.
public virtual string[] AutoSubDomainCreationPatterns { get; set; }
Property Value
System.String[]
Remarks
AutoSubDomainIamRole
The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
public virtual string AutoSubDomainIamRole { get; set; }
Property Value
System.String
Remarks
Length Constraints: Maximum length of 1000.
Pattern: ^$|^arn:aws:iam::\d{12}:role.+
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DomainName
The domain name for the domain association.
public virtual string DomainName { get; set; }
Property Value
System.String
Remarks
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])(.)?$
EnableAutoSubDomain
Enables the automated creation of subdomains for branches.
public virtual object EnableAutoSubDomain { get; set; }
Property Value
System.Object
Remarks
SubDomainSettings
The setting for the subdomain.
public virtual object SubDomainSettings { get; set; }
Property Value
System.Object
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>