# EndpointOptions

properties for creating a domain name endpoint.

- Source: [`aws-apigatewayv2/lib/common/domain-name.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-apigatewayv2/lib/common/domain-name.ts#L106)
- Type last changed: v2.235.0 · 15 Jan 2026

## Example

```ts
// 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 interfaces_certificatemanager } from 'aws-cdk-lib/interfaces';

declare const certificateRef: interfaces_certificatemanager.ICertificateRef;
const endpointOptions: apigatewayv2.EndpointOptions = {
  certificate: certificateRef,

  // the properties below are optional
  certificateName: 'certificateName',
  endpointType: apigatewayv2.EndpointType.EDGE,
  ipAddressType: apigatewayv2.IpAddressType.IPV4,
  ownershipCertificate: certificateRef,
  securityPolicy: apigatewayv2.SecurityPolicy.TLS_1_0,
};
```

## Properties

- `certificate`: [ICertificateRef](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_certificatemanager.ICertificateRef.html) (required) — The ACM certificate for this domain name.

  Certificate can be both ACM issued or imported.

- `certificateName`: string — The user-friendly name of the certificate that will be used by the endpoint for this domain name.

  **Default:** No friendly certificate name

- `endpointType`: [EndpointType](/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.EndpointType.html) = EndpointType.REGIONAL — The type of endpoint for this DomainName.

- `ipAddressType`: [IpAddressType](/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.IpAddressType.html) — The IP address types that can invoke the API.

  **Default:** undefined - AWS default is IPV4

- `ownershipCertificate`: [ICertificateRef](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_certificatemanager.ICertificateRef.html) — A public certificate issued by ACM to validate that you own a custom domain.

  **Default:** only required when configuring mTLS

  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`: [SecurityPolicy](/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.SecurityPolicy.html) = SecurityPolicy.TLS_1_2 — The Transport Layer Security (TLS) version + cipher suite for this domain name.
