DomainNameProps¶

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

__init__(*, certificate, domain_name, endpoint_type=None, security_policy=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
security_policy (Optional[SecurityPolicy]) – The Transport Layer Security (TLS) version + cipher suite for this domain name. Default: SecurityPolicy.TLS_1_0
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.

Return type

None

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.

domain_name¶

The custom domain name for your API.

Uppercase letters are not supported.

endpoint_type¶

The type of endpoint for this DomainName.

default :default: REGIONAL

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:

security_policy¶

The Transport Layer Security (TLS) version + cipher suite for this domain name.

default :default: SecurityPolicy.TLS_1_0