DomainNameOptions

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

Bases: object

__init__(*, certificate, domain_name, endpoint_type=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

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]