DomainNameOptions

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

Bases: object

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). If this is undefined, no additional mappings will be allowed on this domain name.

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

  • mtls (Optional[MTLSConfig]) – 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_0

ExampleMetadata

infused

Example:

# acm_certificate_for_example_com: Any


api = apigateway.RestApi(self, "MyDomain",
    domain_name=apigateway.DomainNameOptions(
        domain_name="example.com",
        certificate=acm_certificate_for_example_com
    )
)

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). If this

is undefined, no additional mappings will be allowed on this domain name.

Return type

Optional[str]

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

REGIONAL

Return type

Optional[EndpointType]

mtls

The mutual TLS authentication configuration for a custom domain name.

Default

  • mTLS is not configured.

Return type

Optional[MTLSConfig]

security_policy

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

Default

SecurityPolicy.TLS_1_0

See

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

Return type

Optional[SecurityPolicy]