aws-cdk-lib.aws_amplify.CfnDomain.SubDomainSettingProperty

interface SubDomainSettingProperty

LanguageType name
.NETAmazon.CDK.AWS.Amplify.CfnDomain.SubDomainSettingProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsamplify#CfnDomain_SubDomainSettingProperty
Javasoftware.amazon.awscdk.services.amplify.CfnDomain.SubDomainSettingProperty
Pythonaws_cdk.aws_amplify.CfnDomain.SubDomainSettingProperty
TypeScript aws-cdk-lib » aws_amplify » CfnDomain » SubDomainSettingProperty

The SubDomainSetting property type enables you to connect a subdomain (for example, example.exampledomain.com) to a specific branch.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_amplify as amplify } from 'aws-cdk-lib';
const subDomainSettingProperty: amplify.CfnDomain.SubDomainSettingProperty = {
  branchName: 'branchName',
  prefix: 'prefix',
};

Properties

NameTypeDescription
branchNamestringThe branch name setting for the subdomain.
prefixstringThe prefix setting for the subdomain.

branchName

Type: string

The branch name setting for the subdomain.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: (?s).+


prefix

Type: string

The prefix setting for the subdomain.

Length Constraints: Maximum length of 255.

Pattern: (?s).*