Class DomainOptions
(experimental) Options to add a domain to an application.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Amplify
Assembly: Amazon.CDK.AWS.Amplify.dll
Syntax (csharp)
public class DomainOptions : Object, IDomainOptions
Syntax (vb)
Public Class DomainOptions
Inherits Object
Implements IDomainOptions
Remarks
Stability: Experimental
ExampleMetadata: infused
Examples
App amplifyApp;
Branch master;
Branch dev;
var domain = amplifyApp.AddDomain("example.com", new DomainOptions {
EnableAutoSubdomain = true, // in case subdomains should be auto registered for branches
AutoSubdomainCreationPatterns = new [] { "*", "pr*" }
});
domain.MapRoot(master); // map master branch to domain root
domain.MapSubDomain(master, "www");
domain.MapSubDomain(dev);
Synopsis
Constructors
DomainOptions() |
Properties
AutoSubdomainCreationPatterns | (experimental) Branches which should automatically create subdomains. |
DomainName | (experimental) The name of the domain. |
EnableAutoSubdomain | (experimental) Automatically create subdomains for connected branches. |
SubDomains | (experimental) Subdomains. |
Constructors
DomainOptions()
public DomainOptions()
Properties
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
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