interface EndpointOptions

Language	Type name
.NET	Amazon.CDK.AWS.Apigatewayv2.EndpointOptions
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#EndpointOptions
Java	software.amazon.awscdk.services.apigatewayv2.EndpointOptions
Python	aws_cdk.aws_apigatewayv2.EndpointOptions
TypeScript (source)	aws-cdk-lib » 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 { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
import { aws_certificatemanager as certificatemanager } from 'aws-cdk-lib';

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

  // the properties below are optional
  certificateName: 'certificateName',
  endpointType: apigatewayv2.EndpointType.EDGE,
  ipAddressType: apigatewayv2.IpAddressType.IPV4,
  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.
ipAddressType?	IpAddressType	The IP address types that can invoke the API.
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.

---

ipAddressType?

Type: IpAddressType (optional, default: undefined - AWS default is IPV4)

The IP address types that can invoke the API.

See also: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-ip-address-type.html

---

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.