DomainNameProps

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

Bases: DomainNameOptions

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.

  • base_path (Optional[str]) – The base path name that callers of the API must provide in the URL after the domain name (e.g. example.com/base-path). If you specify this property, it can’t be an empty string. Default: - map requests from the domain root (e.g. example.com).

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

  • mtls (Union[MTLSConfig, Dict[str, Any], None]) – The mutual TLS authentication configuration for a custom domain name. Default: - mTLS is not configured.

  • security_policy (Optional[SecurityPolicy]) – The Transport Layer Security (TLS) version + cipher suite for this domain name. Default: SecurityPolicy.TLS_1_2

  • 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, use addBasePathMapping or addApiMapping. Default: - you will have to call addBasePathMapping to map this domain to API endpoints.

ExampleMetadata:

infused

Example:

# acm_certificate_for_example_com: Any
# rest_api: apigateway.RestApi


apigateway.DomainName(self, "custom-domain",
    domain_name="example.com",
    certificate=acm_certificate_for_example_com,
    mapping=rest_api,
    base_path="orders/v1/api"
)

Attributes

base_path

The base path name that callers of the API must provide in the URL after the domain name (e.g. example.com/base-path). If you specify this property, it can’t be an empty string.

Default:

  • map requests from the domain root (e.g. example.com).

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:

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, use addBasePathMapping or addApiMapping.

Default:

  • you will have to call addBasePathMapping to map this domain to

API endpoints.

mtls

The mutual TLS authentication configuration for a custom domain name.

Default:

  • mTLS is not configured.

security_policy

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

Default:

SecurityPolicy.TLS_1_2

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html