DomainNameProps

class aws_cdk.aws_apigateway.DomainNameProps(*, certificate, domain_name, endpoint_type=None, mapping=None)

Bases: aws_cdk.aws_apigateway.DomainNameOptions

__init__(*, certificate, domain_name, endpoint_type=None, mapping=None)
Parameters
  • certificate (ICertificate) – The reference to an AWS-managed certificate for use by the edge-optimized endpoint for the domain name. For “EDGE” domain names, the certificate needs to be in the US East (N. Virginia) region.

  • domain_name (str) – The custom domain name for your API. Uppercase letters are not supported.

  • endpoint_type (Optional[EndpointType]) – The type of endpoint for this DomainName. Default: REGIONAL

  • mapping (Optional[IRestApi]) – If specified, all requests to this domain will be mapped to the production deployment of this API. If you wish to map this domain to multiple APIs with different base paths, don’t specify this option and use addBasePathMapping. Default: - you will have to call addBasePathMapping to map this domain to API endpoints.

Attributes

certificate

The reference to an AWS-managed certificate for use by the edge-optimized endpoint for the domain name.

For “EDGE” domain names, the certificate needs to be in the US East (N. Virginia) region.

Return type

ICertificate

domain_name

The custom domain name for your API.

Uppercase letters are not supported.

Return type

str

endpoint_type

The type of endpoint for this DomainName.

default :default: REGIONAL

Return type

Optional[EndpointType]

mapping

If specified, all requests to this domain will be mapped to the production deployment of this API.

If you wish to map this domain to multiple APIs with different base paths, don’t specify this option and use addBasePathMapping.

default :default:

  • you will have to call addBasePathMapping to map this domain to API endpoints.

Return type

Optional[IRestApi]