DomainProps

class aws_cdk.aws_amplify.DomainProps(*, auto_subdomain_creation_patterns=None, domain_name=None, enable_auto_subdomain=None, sub_domains=None, app, auto_sub_domain_iam_role=None)

Bases: aws_cdk.aws_amplify.DomainOptions

(experimental) Properties for a Domain.

Parameters
  • auto_subdomain_creation_patterns (Optional[Sequence[str]]) – (experimental) Branches which should automatically create subdomains. Default: - all repository branches [‘*’, ‘pr*’]

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

  • enable_auto_subdomain (Optional[bool]) – (experimental) Automatically create subdomains for connected branches. Default: false

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

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

  • auto_sub_domain_iam_role (Optional[IRole]) – (experimental) The IAM role with access to Route53 when using enableAutoSubdomain. Default: the IAM role from App.grantPrincipal

Stability

experimental

Attributes

app

(experimental) The application to which the domain must be connected.

Stability

experimental

Return type

IApp

auto_sub_domain_iam_role

(experimental) The IAM role with access to Route53 when using enableAutoSubdomain.

Default

the IAM role from App.grantPrincipal

Stability

experimental

Return type

Optional[IRole]

auto_subdomain_creation_patterns

(experimental) Branches which should automatically create subdomains.

Default
  • all repository branches [‘*’, ‘pr*’]

Stability

experimental

Return type

Optional[List[str]]

domain_name

(experimental) The name of the domain.

Default
  • the construct’s id

Stability

experimental

Return type

Optional[str]

enable_auto_subdomain

(experimental) Automatically create subdomains for connected branches.

Default

false

Stability

experimental

Return type

Optional[bool]

sub_domains

(experimental) Subdomains.

Default
  • use addSubDomain() to add subdomains

Stability

experimental

Return type

Optional[List[SubDomain]]