EndpointOptions

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

Bases: object

(experimental) properties for creating a domain name endpoint.

Parameters
  • certificate (ICertificate) – (experimental) The ACM certificate for this domain name. Certificate can be both ACM issued or imported.

  • certificate_name (Optional[str]) – (experimental) 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]) – (experimental) The type of endpoint for this DomainName. Default: EndpointType.REGIONAL

  • ownership_certificate (Optional[ICertificate]) – (experimental) 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]) – (experimental) The Transport Layer Security (TLS) version + cipher suite for this domain name. Default: SecurityPolicy.TLS_1_2

Stability

experimental

ExampleMetadata

fixture=_generated

Example:

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

# certificate is of type Certificate

endpoint_options = apigatewayv2.EndpointOptions(
    certificate=certificate,

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

Attributes

certificate

(experimental) The ACM certificate for this domain name.

Certificate can be both ACM issued or imported.

Stability

experimental

Return type

ICertificate

certificate_name

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

Default
  • No friendly certificate name

Stability

experimental

Return type

Optional[str]

endpoint_type

(experimental) The type of endpoint for this DomainName.

Default

EndpointType.REGIONAL

Stability

experimental

Return type

Optional[EndpointType]

ownership_certificate

(experimental) 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

Stability

experimental

Return type

Optional[ICertificate]

security_policy

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

Default

SecurityPolicy.TLS_1_2

Stability

experimental

Return type

Optional[SecurityPolicy]