AWS CDK Reference

Appearance

v2.273.0

DomainNameAttributes Struct ​

Source
aws-apigateway/lib/domain-name.ts

Example ​

ts
declare const api: apigateway.RestApi;

const domainName = apigateway.DomainName.fromDomainNameAttributes(this, 'DomainName', {
  domainName: 'domainName',
  domainNameAliasHostedZoneId: 'domainNameAliasHostedZoneId',
  domainNameAliasTarget: 'domainNameAliasTarget',
});

new apigateway.BasePathMapping(this, 'BasePathMapping', {
  domainName: domainName,
  restApi: api,
});

Properties ​

domainNamestringdomain_namestrdomainNameStringDomainNamestringDomainName*stringrequired#
The domain name (e.g. `example.com`).
domainNameAliasHostedZoneIdstringdomain_name_alias_hosted_zone_idstrdomainNameAliasHostedZoneIdStringDomainNameAliasHostedZoneIdstringDomainNameAliasHostedZoneId*stringrequired#
The Route53 hosted zone ID to use in order to connect a record set to this domain through an alias.
domainNameAliasTargetstringdomain_name_alias_targetstrdomainNameAliasTargetStringDomainNameAliasTargetstringDomainNameAliasTarget*stringrequired#
The Route53 alias target to use in order to connect a record set to this domain through an alias.