Experimental
@aws-cdk/aws-amplify-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
DomainProps Struct
Properties for a Domain.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as amplify_alpha from '@aws-cdk/aws-amplify-alpha';
import { aws_certificatemanager as certificatemanager } from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';
declare const app: amplify_alpha.App;
declare const branch: amplify_alpha.Branch;
declare const certificate: certificatemanager.Certificate;
declare const role: iam.Role;
const domainProps: amplify_alpha.DomainProps = {
app: app,
// the properties below are optional
autoSubdomainCreationPatterns: ['autoSubdomainCreationPatterns'],
autoSubDomainIamRole: role,
customCertificate: certificate,
domainName: 'domainName',
enableAutoSubdomain: false,
subDomains: [{
branch: branch,
// the properties below are optional
prefix: 'prefix',
}],
};
Properties
autoSubdomainCreationPatternsoptionalstring[]auto_subdomain_creation_patternsoptionaltyping.List[str]autoSubdomainCreationPatternsoptionalList<String>AutoSubdomainCreationPatternsoptionalstring[]AutoSubdomainCreationPatternsoptional*[]*string#Branches which should automatically create subdomains.
Default: all repository branches ['', 'pr']
autoSubDomainIamRoleoptionalIRoleauto_sub_domain_iam_roleoptionalIRoleautoSubDomainIamRoleoptionalIRoleAutoSubDomainIamRoleoptionalIRoleAutoSubDomainIamRoleoptionalIRole#The IAM role with access to Route53 when using enableAutoSubdomain.
Default: the IAM role from App.grantPrincipal
customCertificateoptionalICertificatecustom_certificateoptionalICertificatecustomCertificateoptionalICertificateCustomCertificateoptionalICertificateCustomCertificateoptionalICertificate#The type of SSL/TLS certificate to use for your custom domain.
Default: Amplify uses the default certificate that it provisions and manages for you
domainNameoptionalstringdomain_nameoptionalstrdomainNameoptionalStringDomainNameoptionalstringDomainNameoptional*string#The name of the domain.
Default: the construct's id
enableAutoSubdomainoptionalbooleanenable_auto_subdomainoptionalboolenableAutoSubdomainoptionalBooleanEnableAutoSubdomainoptionalboolEnableAutoSubdomainoptional*bool= false#Automatically create subdomains for connected branches.