EndpointOptions

class aws_cdk.aws_apigatewayv2.EndpointOptions(*, certificate, certificate_name=None, endpoint_type=None, ip_address_type=None, ownership_certificate=None, security_policy=None)

Bases: object

properties for creating a domain name endpoint.

Parameters:

certificate (ICertificate) – The ACM certificate for this domain name. Certificate can be both ACM issued or imported.
certificate_name (Optional[str]) – The user-friendly name of the certificate that will be used by the endpoint for this domain name. Default: - No friendly certificate name
endpoint_type (Optional[EndpointType]) – The type of endpoint for this DomainName. Default: EndpointType.REGIONAL
ip_address_type (Optional[IpAddressType]) – The IP address types that can invoke the API. Default: undefined - AWS default is IPV4
ownership_certificate (Optional[ICertificate]) – A public certificate issued by ACM to validate that you own a custom domain. This parameter is required only when you configure mutual TLS authentication and you specify an ACM imported or private CA certificate for certificate. The ownership certificate validates that you have permissions to use the domain name. Default: - only required when configuring mTLS
security_policy (Optional[SecurityPolicy]) – The Transport Layer Security (TLS) version + cipher suite for this domain name. Default: SecurityPolicy.TLS_1_2

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_apigatewayv2 as apigatewayv2
from aws_cdk import aws_certificatemanager as certificatemanager

# certificate: certificatemanager.Certificate

endpoint_options = apigatewayv2.EndpointOptions(
    certificate=certificate,

    # the properties below are optional
    certificate_name="certificateName",
    endpoint_type=apigatewayv2.EndpointType.EDGE,
    ip_address_type=apigatewayv2.IpAddressType.IPV4,
    ownership_certificate=certificate,
    security_policy=apigatewayv2.SecurityPolicy.TLS_1_0
)

Attributes

certificate

The ACM certificate for this domain name.

Certificate can be both ACM issued or imported.

certificate_name

The user-friendly name of the certificate that will be used by the endpoint for this domain name.

Default:

No friendly certificate name

endpoint_type

The type of endpoint for this DomainName.

Default:: EndpointType.REGIONAL

ip_address_type

The IP address types that can invoke the API.

Default:: undefined - AWS default is IPV4
See:: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-ip-address-type.html

ownership_certificate

A public certificate issued by ACM to validate that you own a custom domain.

This parameter is required only when you configure mutual TLS authentication and you specify an ACM imported or private CA certificate for certificate. The ownership certificate validates that you have permissions to use the domain name.

Default:

only required when configuring mTLS

security_policy

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

Default:: SecurityPolicy.TLS_1_2