interface SubDomainSettingProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Amplify.Mixins.CfnDomainPropsMixin.SubDomainSettingProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsamplify/mixins#CfnDomainPropsMixin_SubDomainSettingProperty
Java	software.amazon.awscdk.mixins.preview.services.amplify.mixins.CfnDomainPropsMixin.SubDomainSettingProperty
Python	aws_cdk.mixins_preview.aws_amplify.mixins.CfnDomainPropsMixin.SubDomainSettingProperty
TypeScript	@aws-cdk/mixins-preview » aws_amplify » mixins » CfnDomainPropsMixin » SubDomainSettingProperty

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-domain-subdomainsetting.html

Example

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

Properties

Name	Type	Description
branchName?	string	The branch name setting for the subdomain.
prefix?	string	The prefix setting for the subdomain.

---

branchName?

Type: string (optional)

The branch name setting for the subdomain.

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

Pattern: (?s).+

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-domain-subdomainsetting.html#cfn-amplify-domain-subdomainsetting-branchname

---

prefix?

Type: string (optional)

The prefix setting for the subdomain.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-domain-subdomainsetting.html#cfn-amplify-domain-subdomainsetting-prefix