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). 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 (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_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.

ExampleMetadata

infused

Example:

# acm: Any


apigateway.DomainName(self, "domain-name",
    domain_name="example.com",
    certificate=acm.Certificate.from_certificate_arn(self, "cert", "arn:aws:acm:us-east-1:1111111:certificate/11-3336f1-44483d-adc7-9cd375c5169d"),
    mtls=apigateway.MTLSConfig(
        bucket=s3.Bucket(self, "bucket"),
        key="truststore.pem",
        version="version"
    )
)

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]

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

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

API endpoints.

Return type

Optional[IRestApi]

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]