Class DomainProps
(experimental) Properties for a Domain.
Inheritance
Namespace: Amazon.CDK.AWS.Amplify
Assembly: Amazon.CDK.AWS.Amplify.dll
Syntax (csharp)
public class DomainProps : Object, IDomainProps, IDomainOptions
Syntax (vb)
Public Class DomainProps
Inherits Object
Implements IDomainProps, IDomainOptions
Remarks
Stability: Experimental
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;
using Amazon.CDK.AWS.IAM;
App app;
Branch branch;
Role role;
var domainProps = new DomainProps {
App = app,
// the properties below are optional
AutoSubdomainCreationPatterns = new [] { "autoSubdomainCreationPatterns" },
AutoSubDomainIamRole = role,
DomainName = "domainName",
EnableAutoSubdomain = false,
SubDomains = new [] { new SubDomain {
Branch = branch,
// the properties below are optional
Prefix = "prefix"
} }
};
Synopsis
Constructors
DomainProps() |
Properties
App | (experimental) The application to which the domain must be connected. |
AutoSubdomainCreationPatterns | (experimental) Branches which should automatically create subdomains. |
AutoSubDomainIamRole | (experimental) The IAM role with access to Route53 when using enableAutoSubdomain. |
DomainName | (experimental) The name of the domain. |
EnableAutoSubdomain | (experimental) Automatically create subdomains for connected branches. |
SubDomains | (experimental) Subdomains. |
Constructors
DomainProps()
public DomainProps()
Properties
App
(experimental) The application to which the domain must be connected.
public IApp App { get; set; }
Property Value
Remarks
Stability: Experimental
AutoSubdomainCreationPatterns
(experimental) Branches which should automatically create subdomains.
public string[] AutoSubdomainCreationPatterns { get; set; }
Property Value
System.String[]
Remarks
Default: - all repository branches ['', 'pr']
Stability: Experimental
AutoSubDomainIamRole
(experimental) The IAM role with access to Route53 when using enableAutoSubdomain.
public IRole AutoSubDomainIamRole { get; set; }
Property Value
Remarks
Default: the IAM role from App.grantPrincipal
Stability: Experimental
DomainName
(experimental) The name of the domain.
public string DomainName { get; set; }
Property Value
System.String
Remarks
Default: - the construct's id
Stability: Experimental
EnableAutoSubdomain
(experimental) Automatically create subdomains for connected branches.
public Nullable<bool> EnableAutoSubdomain { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Stability: Experimental
SubDomains
(experimental) Subdomains.
public ISubDomain[] SubDomains { get; set; }
Property Value
Remarks
Default: - use addSubDomain()
to add subdomains
Stability: Experimental