Class CfnDomainProps
Properties for defining a CfnDomain
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Amplify
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDomainProps : Object, ICfnDomainProps
Syntax (vb)
Public Class CfnDomainProps
Inherits Object
Implements ICfnDomainProps
Remarks
See: 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",
CertificateSettings = new CertificateSettingsProperty {
CertificateType = "certificateType",
CustomCertificateArn = "customCertificateArn"
},
EnableAutoSubDomain = false
};
Synopsis
Constructors
CfnDomainProps() |
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 (IAMlong) service role for the Amazon Resource Name (ARN) for automatically creating subdomains. |
CertificateSettings | The type of SSL/TLS certificate to use for your custom domain. |
DomainName | The domain name for the domain association. |
EnableAutoSubDomain | Enables the automated creation of subdomains for branches. |
SubDomainSettings | The setting for the subdomain. |
Constructors
CfnDomainProps()
public CfnDomainProps()
Properties
AppId
The unique ID for an Amplify app.
public string AppId { get; set; }
Property Value
System.String
Remarks
AutoSubDomainCreationPatterns
Sets the branch patterns for automatic subdomain creation.
public string[] AutoSubDomainCreationPatterns { get; set; }
Property Value
System.String[]
Remarks
AutoSubDomainIamRole
The required AWS Identity and Access Management (IAMlong) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
public string AutoSubDomainIamRole { get; set; }
Property Value
System.String
Remarks
CertificateSettings
The type of SSL/TLS certificate to use for your custom domain.
public object CertificateSettings { get; set; }
Property Value
System.Object
Remarks
If you don't specify a certificate type, Amplify uses the default certificate that it provisions and manages for you.
DomainName
The domain name for the domain association.
public string DomainName { get; set; }
Property Value
System.String
Remarks
EnableAutoSubDomain
Enables the automated creation of subdomains for branches.
public object EnableAutoSubDomain { get; set; }
Property Value
System.Object
Remarks
SubDomainSettings
The setting for the subdomain.
public object SubDomainSettings { get; set; }
Property Value
System.Object