SubDomain

class aws_cdk.aws_amplify.SubDomain(*, branch, prefix=None)

Bases: object

(experimental) Sub domain settings.

Parameters
  • branch (IBranch) – (experimental) The branch.

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

Stability

experimental

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_amplify as amplify

# branch is of type Branch

sub_domain = amplify.SubDomain(
    branch=branch,

    # the properties below are optional
    prefix="prefix"
)

Attributes

branch

(experimental) The branch.

Stability

experimental

Return type

IBranch

prefix

(experimental) The prefix.

Use ‘’ to map to the root of the domain

Default
  • the branch name

Stability

experimental

Return type

Optional[str]