interface CfnDomainProps

Language	Type name
.NET	Amazon.CDK.AWS.Amplify.CfnDomainProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsamplify#CfnDomainProps
Java	software.amazon.awscdk.services.amplify.CfnDomainProps
Python	aws_cdk.aws_amplify.CfnDomainProps
TypeScript	aws-cdk-lib » aws_amplify » CfnDomainProps

Properties for defining a CfnDomain.

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 { aws_amplify as amplify } from 'aws-cdk-lib';
const cfnDomainProps: amplify.CfnDomainProps = {
  appId: 'appId',
  domainName: 'domainName',
  subDomainSettings: [{
    branchName: 'branchName',
    prefix: 'prefix',
  }],

  // the properties below are optional
  autoSubDomainCreationPatterns: ['autoSubDomainCreationPatterns'],
  autoSubDomainIamRole: 'autoSubDomainIamRole',
  certificateSettings: {
    certificateType: 'certificateType',
    customCertificateArn: 'customCertificateArn',
  },
  enableAutoSubDomain: false,
};

Properties

Name	Type	Description
appId	string	The unique ID for an Amplify app.
domainName	string	The domain name for the domain association.
subDomainSettings	IResolvable | IResolvable | SubDomainSettingProperty[]	The setting for the subdomain.
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.
enableAutoSubDomain?	boolean | IResolvable	Enables the automated creation of subdomains for branches.

---

appId

Type: string

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

---

domainName

Type: string

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

---

subDomainSettings

Type: IResolvable | IResolvable | SubDomainSettingProperty[]

The setting for the subdomain.

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

---

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

---

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