@aws-cdk_aws-amplify-alpha.DomainProps

interface DomainProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Amplify.Alpha.DomainProps
Gogithub.com/aws/aws-cdk-go/awscdkamplifyalpha/v2#DomainProps
Javasoftware.amazon.awscdk.services.amplify.alpha.DomainProps
Pythonaws_cdk.aws_amplify_alpha.DomainProps
TypeScript (source)@aws-cdk/aws-amplify-alpha ยป DomainProps

Properties for a Domain.

Example

// 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_iam as iam } from 'aws-cdk-lib';

declare const app: amplify_alpha.App;
declare const branch: amplify_alpha.Branch;
declare const role: iam.Role;
const domainProps: amplify_alpha.DomainProps = {
  app: app,

  // the properties below are optional
  autoSubdomainCreationPatterns: ['autoSubdomainCreationPatterns'],
  autoSubDomainIamRole: role,
  domainName: 'domainName',
  enableAutoSubdomain: false,
  subDomains: [{
    branch: branch,

    // the properties below are optional
    prefix: 'prefix',
  }],
};

Properties

NameTypeDescription
app๐Ÿ”นIAppThe application to which the domain must be connected.
autoSubDomainIamRole?๐Ÿ”นIRoleThe IAM role with access to Route53 when using enableAutoSubdomain.
autoSubdomainCreationPatterns?๐Ÿ”นstring[]Branches which should automatically create subdomains.
domainName?๐Ÿ”นstringThe name of the domain.
enableAutoSubdomain?๐Ÿ”นbooleanAutomatically create subdomains for connected branches.
subDomains?๐Ÿ”นSubDomain[]Subdomains.

app๐Ÿ”น

Type: IApp

The application to which the domain must be connected.


autoSubDomainIamRole?๐Ÿ”น

Type: IRole (optional, default: the IAM role from App.grantPrincipal)

The IAM role with access to Route53 when using enableAutoSubdomain.


autoSubdomainCreationPatterns?๐Ÿ”น

Type: string[] (optional, default: all repository branches ['', 'pr'])

Branches which should automatically create subdomains.


domainName?๐Ÿ”น

Type: string (optional, default: the construct's id)

The name of the domain.


enableAutoSubdomain?๐Ÿ”น

Type: boolean (optional, default: false)

Automatically create subdomains for connected branches.


subDomains?๐Ÿ”น

Type: SubDomain[] (optional, default: use addSubDomain() to add subdomains)

Subdomains.