Domain

class aws_cdk.aws_amplify.Domain(scope, id, *, app, domain_name=None, sub_domains=None)

Bases: aws_cdk.core.Resource

An Amplify Console domain.

stability :stability: experimental

__init__(scope, id, *, app, domain_name=None, sub_domains=None)
Parameters
  • scope (Construct) –

  • id (str) –

  • app (IApp) – The application to which the domain must be connected.

  • domain_name (Optional[str]) – The name of the domain. Default: - the construct’s id

  • sub_domains (Optional[List[SubDomain]]) – Subdomains. Default: - use addSubDomain() to add subdomains

stability :stability: experimental

Return type

None

Methods

map_root(branch)

Maps a branch to the domain root.

Parameters

branch (IBranch) –

stability :stability: experimental

Return type

Domain

map_sub_domain(branch, prefix=None)

Maps a branch to a sub domain.

Parameters
  • branch (IBranch) – The branch.

  • prefix (Optional[str]) – The prefix. Use ‘’ to map to the root of the domain. Defaults to branch name.

stability :stability: experimental

Return type

Domain

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

arn

The ARN of the domain.

stability :stability: experimental attribute: :attribute:: true

Return type

str

certificate_record

The DNS Record for certificate verification.

stability :stability: experimental attribute: :attribute:: true

Return type

str

domain_name

The name of the domain.

stability :stability: experimental attribute: :attribute:: true

Return type

str

domain_status

The status of the domain association.

stability :stability: experimental attribute: :attribute:: true

Return type

str

node

The construct tree node associated with this construct.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack

status_reason

The reason for the current status of the domain.

stability :stability: experimental attribute: :attribute:: true

Return type

str

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool