Class Domain

(experimental) An Amplify Console domain.

Inheritance

System.Object

Resource

Domain

Implements

IResource

Constructs.IConstruct

Constructs.IDependable

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(String, IArnComponents)

Resource.GetResourceNameAttribute(String)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.Amplify.Alpha

Assembly: Amazon.CDK.AWS.Amplify.Alpha.dll

Syntax (csharp)

public class Domain : Resource, IResource

Syntax (vb)

Public Class Domain
    Inherits Resource
    Implements IResource

Remarks

Stability: Experimental

ExampleMetadata: infused

Examples

App amplifyApp;
Branch main;
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(main); // map main branch to domain root
domain.MapSubDomain(main, "www");
domain.MapSubDomain(dev);

Synopsis

Constructors

Domain(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
Domain(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps
Domain(Construct, String, IDomainProps)

Properties

Arn	(experimental) The ARN of the domain.
CertificateRecord	(experimental) The DNS Record for certificate verification.
DomainAutoSubDomainCreationPatterns	(experimental) Branch patterns for the automatically created subdomain.
DomainAutoSubDomainIamRole	(experimental) The IAM service role for the subdomain.
DomainEnableAutoSubDomain	(experimental) Specifies whether the automated creation of subdomains for branches is enabled.
DomainName	(experimental) The name of the domain.
DomainStatus	(experimental) The status of the domain association.
StatusReason	(experimental) The reason for the current status of the domain.

Methods

MapRoot(IBranch)	(experimental) Maps a branch to the domain root.
MapSubDomain(IBranch, String)	(experimental) Maps a branch to a sub domain.

Constructors

Domain(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected Domain(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

Domain(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected Domain(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Domain(Construct, String, IDomainProps)

public Domain(Construct scope, string id, IDomainProps props)

Parameters

scope Constructs.Construct

id System.String

props IDomainProps

Remarks

Stability: Experimental

Properties

Arn

(experimental) The ARN of the domain.

public virtual string Arn { get; }

Property Value

System.String

Remarks

Stability: Experimental

Attribute: true

CertificateRecord

(experimental) The DNS Record for certificate verification.

public virtual string CertificateRecord { get; }

Property Value

System.String

Remarks

Stability: Experimental

Attribute: true

DomainAutoSubDomainCreationPatterns

(experimental) Branch patterns for the automatically created subdomain.

public virtual string[] DomainAutoSubDomainCreationPatterns { get; }

Property Value

System.String[]

Remarks

Stability: Experimental

Attribute: true

DomainAutoSubDomainIamRole

(experimental) The IAM service role for the subdomain.

public virtual string DomainAutoSubDomainIamRole { get; }

Property Value

System.String

Remarks

Stability: Experimental

Attribute: true

DomainEnableAutoSubDomain

(experimental) Specifies whether the automated creation of subdomains for branches is enabled.

public virtual IResolvable DomainEnableAutoSubDomain { get; }

Property Value

IResolvable

Remarks

Stability: Experimental

Attribute: true

DomainName

(experimental) The name of the domain.

public virtual string DomainName { get; }

Property Value

System.String

Remarks

Stability: Experimental

Attribute: true

DomainStatus

(experimental) The status of the domain association.

public virtual string DomainStatus { get; }

Property Value

System.String

Remarks

Stability: Experimental

Attribute: true

StatusReason

(experimental) The reason for the current status of the domain.

public virtual string StatusReason { get; }

Property Value

System.String

Remarks

Stability: Experimental

Attribute: true

Methods

MapRoot(IBranch)

(experimental) Maps a branch to the domain root.

public virtual Domain MapRoot(IBranch branch)

Parameters

branch IBranch

Returns

Domain

Remarks

Stability: Experimental

MapSubDomain(IBranch, String)

(experimental) Maps a branch to a sub domain.

public virtual Domain MapSubDomain(IBranch branch, string prefix = null)

Parameters

branch IBranch

The branch.

prefix System.String

The prefix.

Returns

Domain

Remarks

Stability: Experimental

Implements

IResource

Constructs.IConstruct

Constructs.IDependable