DomainNameAttributes

class aws_cdk.aws_apigateway.DomainNameAttributes(*, domain_name, domain_name_alias_hosted_zone_id, domain_name_alias_target)

Bases: object

Parameters:
  • domain_name (str) – The domain name (e.g. example.com).

  • domain_name_alias_hosted_zone_id (str) – The Route53 hosted zone ID to use in order to connect a record set to this domain through an alias.

  • domain_name_alias_target (str) – The Route53 alias target to use in order to connect a record set to this domain through an alias.

ExampleMetadata:

infused

Example:

# api: apigateway.RestApi


domain_name = apigateway.DomainName.from_domain_name_attributes(self, "DomainName",
    domain_name="domainName",
    domain_name_alias_hosted_zone_id="domainNameAliasHostedZoneId",
    domain_name_alias_target="domainNameAliasTarget"
)

apigateway.BasePathMapping(self, "BasePathMapping",
    domain_name=domain_name,
    rest_api=api
)

Attributes

domain_name

The domain name (e.g. example.com).

domain_name_alias_hosted_zone_id

The Route53 hosted zone ID to use in order to connect a record set to this domain through an alias.

domain_name_alias_target

The Route53 alias target to use in order to connect a record set to this domain through an alias.