interface CfnDomainMixinProps

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

Properties for CfnDomainPropsMixin.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.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 cfnDomainMixinProps: amplify_mixins.CfnDomainMixinProps = {
  appId: 'appId',
  autoSubDomainCreationPatterns: ['autoSubDomainCreationPatterns'],
  autoSubDomainIamRole: 'autoSubDomainIamRole',
  certificateSettings: {
    certificateType: 'certificateType',
    customCertificateArn: 'customCertificateArn',
  },
  domainName: 'domainName',
  enableAutoSubDomain: false,
  subDomainSettings: [{
    branchName: 'branchName',
    prefix: 'prefix',
  }],
};

Properties

Name	Type	Description
appId?	string	The unique ID for an Amplify app.
autoSubDomainCreationPatterns?	string[]	Sets the branch patterns for automatic subdomain creation.
autoSubDomainIamRole?	string	The required AWS Identity and Access Management (IAMlong) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
certificateSettings?	IResolvable | CertificateSettingsProperty	The type of SSL/TLS certificate to use for your custom domain.
domainName?	string	The domain name for the domain association.
enableAutoSubDomain?	boolean | IResolvable	Enables the automated creation of subdomains for branches.
subDomainSettings?	IResolvable | (IResolvable | SubDomainSettingProperty)[]	The setting for the subdomain.

---

appId?

Type: string (optional)

The unique ID for an Amplify app.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-appid

---

autoSubDomainCreationPatterns?

Type: string[] (optional)

Sets the branch patterns for automatic subdomain creation.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-autosubdomaincreationpatterns

---

autoSubDomainIamRole?

Type: string (optional)

The required AWS Identity and Access Management (IAMlong) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-autosubdomainiamrole

---

certificateSettings?

Type: IResolvable | CertificateSettingsProperty (optional)

The type of SSL/TLS certificate to use for your custom domain.

If you don't specify a certificate type, Amplify uses the default certificate that it provisions and manages for you.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-certificatesettings

---

domainName?

Type: string (optional)

The domain name for the domain association.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-domainname

---

enableAutoSubDomain?

Type: boolean | IResolvable (optional)

Enables the automated creation of subdomains for branches.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-enableautosubdomain

---

subDomainSettings?

Type: IResolvable | (IResolvable | SubDomainSettingProperty)[] (optional)

The setting for the subdomain.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-domain.html#cfn-amplify-domain-subdomainsettings