Interface ICfnDomainProps
Properties for defining a CfnDomain
.
Namespace: Amazon.CDK.AWS.Amplify
Assembly: Amazon.CDK.AWS.Amplify.dll
Syntax (csharp)
public interface ICfnDomainProps
Syntax (vb)
Public Interface ICfnDomainProps
Remarks
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 cfnDomainProps = 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
Properties
AppId | The unique ID for an Amplify app. |
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. |
DomainName | The domain name for the domain association. |
EnableAutoSubDomain | Enables the automated creation of subdomains for branches. |
SubDomainSettings | The setting for the subdomain. |
Properties
AppId
The unique ID for an Amplify app.
string AppId { get; }
Property Value
System.String
Remarks
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern: d[a-z0-9]+
AutoSubDomainCreationPatterns
Sets the branch patterns for automatic subdomain creation.
virtual string[] AutoSubDomainCreationPatterns { get; }
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.
virtual string AutoSubDomainIamRole { get; }
Property Value
System.String
Remarks
Length Constraints: Maximum length of 1000.
Pattern: ^$|^arn:aws:iam::\d{12}:role.+
DomainName
The domain name for the domain association.
string DomainName { get; }
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.
virtual object EnableAutoSubDomain { get; }
Property Value
System.Object
Remarks
SubDomainSettings
The setting for the subdomain.
object SubDomainSettings { get; }
Property Value
System.Object