@aws-cdk_aws-apigatewayv2-alpha.EndpointOptions

interface EndpointOptions ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.Alpha.EndpointOptions
Gogithub.com/aws/aws-cdk-go/awscdkapigatewayv2alpha/v2#EndpointOptions
Javasoftware.amazon.awscdk.services.apigatewayv2.alpha.EndpointOptions
Pythonaws_cdk.aws_apigatewayv2_alpha.EndpointOptions
TypeScript (source)@aws-cdk/aws-apigatewayv2-alpha ยป 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_alpha from '@aws-cdk/aws-apigatewayv2-alpha';
import { aws_certificatemanager as certificatemanager } from 'aws-cdk-lib';

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

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

Properties

NameTypeDescription
certificate๐Ÿ”นICertificateThe ACM certificate for this domain name.
certificateName?๐Ÿ”นstringThe user-friendly name of the certificate that will be used by the endpoint for this domain name.
endpointType?๐Ÿ”นEndpointTypeThe type of endpoint for this DomainName.
ownershipCertificate?๐Ÿ”นICertificateA public certificate issued by ACM to validate that you own a custom domain.
securityPolicy?๐Ÿ”นSecurityPolicyThe 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.