Experimental
@aws-cdk/aws-amplify-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
DomainOptions Struct
Options to add a domain to an application.
Example
ts
declare const amplifyApp: amplify.App;
declare const main: amplify.Branch;
declare const dev: amplify.Branch;
const domain = amplifyApp.addDomain('example.com', {
enableAutoSubdomain: true, // in case subdomains should be auto registered for branches
autoSubdomainCreationPatterns: ['*', 'pr*'], // regex for branches that should auto register subdomains
});
domain.mapRoot(main); // map main branch to domain root
domain.mapSubDomain(main, 'www');
domain.mapSubDomain(dev); // sub domain prefix defaults to branch name
Properties
autoSubdomainCreationPatternsoptionalstring[]auto_subdomain_creation_patternsoptionaltyping.List[str]autoSubdomainCreationPatternsoptionalList<String>AutoSubdomainCreationPatternsoptionalstring[]AutoSubdomainCreationPatternsoptional*[]*string#Branches which should automatically create subdomains.
Default: all repository branches ['', 'pr']
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.