@aws-cdk/aws-amplify-alpha.SubDomain

Experimental

@aws-cdk/aws-amplify-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

SubDomain Struct

Sub domain settings.

Stability

Experimental

Source

lib/domain.ts

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as amplify_alpha from '@aws-cdk/aws-amplify-alpha';

declare const branch: amplify_alpha.Branch;
const subDomain: amplify_alpha.SubDomain = {
  branch: branch,

  // the properties below are optional
  prefix: 'prefix',
};

Properties

branchIBranchbranchIBranchbranchIBranchBranchIBranchBranchIBranchrequired#

The branch.

prefix?optionalstringprefix?optionalstrprefix?optionalStringPrefix?optionalstringPrefix?optional*string#

The prefix.

Default: the branch name

Use '' to map to the root of the domain