AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Amplify::Domain

CfnDomain

Specifies the AWS::Amplify::Domain resource that enables you to connect a custom domain to your app.

Import

import { CfnDomain } from 'aws-cdk-lib/aws-amplify';

Or use the module namespace:

import * as amplify from 'aws-cdk-lib/aws-amplify';
// amplify.CfnDomain

Properties

Configuration passed to the constructor as CfnDomainProps.

appIdRequired
string

The unique ID for an Amplify app.

domainNameRequired
string

The domain name for the domain association.

subDomainSettingsRequired
IResolvable | IResolvable | SubDomainSettingProperty[]

The setting for the subdomain.

autoSubDomainCreationPatternsOptional
string[]

Sets the branch patterns for automatic subdomain creation.

autoSubDomainIamRoleOptional
string | IRoleRef

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

certificateSettingsOptional
IResolvable | CertificateSettingsProperty

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.

enableAutoSubDomainOptional
boolean | IResolvable

Enables the automated creation of subdomains for branches.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::Amplify::DomainView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-amplify
CFN TypeAWS::Amplify::Domain
Properties7

Related Constructs

Explore This Service

External Links