interface EndpointOptions 🔹

Language	Type name
.NET	`Amazon.CDK.AWS.APIGatewayv2.EndpointOptions`
Java	`software.amazon.awscdk.services.apigatewayv2.EndpointOptions`
Python	`aws_cdk.aws_apigatewayv2.EndpointOptions`
TypeScript (source)	`@aws-cdk/aws-apigatewayv2` » `EndpointOptions`

properties for creating a domain name endpoint.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as apigatewayv2 from '@aws-cdk/aws-apigatewayv2';
import * as certificatemanager from '@aws-cdk/aws-certificatemanager';

declare const certificate: certificatemanager.Certificate;
const endpointOptions: apigatewayv2.EndpointOptions = {
  certificate: certificate,

  // the properties below are optional
  certificateName: 'certificateName',
  endpointType: apigatewayv2.EndpointType.EDGE,
  ownershipCertificate: certificate,
  securityPolicy: apigatewayv2.SecurityPolicy.TLS_1_0,
};

Properties

Name	Type	Description
certificate🔹	`ICertificate`	The ACM certificate for this domain name.
certificateName?🔹	`string`	The user-friendly name of the certificate that will be used by the endpoint for this domain name.
endpointType?🔹	`EndpointType`	The type of endpoint for this DomainName.
ownershipCertificate?🔹	`ICertificate`	A public certificate issued by ACM to validate that you own a custom domain.
securityPolicy?🔹	`SecurityPolicy`	The Transport Layer Security (TLS) version + cipher suite for this domain name.

certificate🔹

Type: ICertificate

The ACM certificate for this domain name.

Certificate can be both ACM issued or imported.

certificateName?🔹

Type: string (optional, default: No friendly certificate name)

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

endpointType?🔹

Type: EndpointType (optional, default: EndpointType.REGIONAL)

The type of endpoint for this DomainName.

ownershipCertificate?🔹

Type: ICertificate (optional, default: only required when configuring mTLS)

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.

securityPolicy?🔹

Type: SecurityPolicy (optional, default: SecurityPolicy.TLS_1_2)

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