aws-cdk-lib.aws_apigateway.EndpointConfiguration

EndpointConfiguration Struct

The endpoint configuration of a REST API, including VPCs and endpoint types.

EndpointConfiguration is a property of the AWS::ApiGateway::RestApi resource.

Source

aws-apigateway/lib/restapi.ts

Type last changed

v2.195.0 · 7 May 2025

Example

declare const someEndpoint: ec2.IVpcEndpoint;

const api = new apigateway.RestApi(this, 'api', {
  endpointConfiguration: {
    types: [ apigateway.EndpointType.PRIVATE ],
    vpcEndpoints: [ someEndpoint ]
  }
});

Properties

ipAddressType?optionalIpAddressTypeip_address_type?optionalIpAddressTypeipAddressType?optionalIpAddressTypeIpAddressType?optionalIpAddressTypeIpAddressType?optionalIpAddressType#

The IP address types that can invoke the API.

Default: undefined - AWS default is DUAL_STACK for private API, IPV4 for all other APIs.

typesEndpointType[]typestyping.List[EndpointType]typesList<EndpointType>TypesEndpointType[]Types*[]EndpointType= EndpointType.EDGErequired#

A list of endpoint types of an API or its custom domain name.

vpcEndpoints?optionalIVpcEndpoint[]vpc_endpoints?optionaltyping.List[IVpcEndpoint]vpcEndpoints?optionalList<IVpcEndpoint>VpcEndpoints?optionalIVpcEndpoint[]VpcEndpoints?optional*[]IVpcEndpoint#

A list of VPC Endpoints against which to create Route53 ALIASes.

Default: no ALIASes are created for the endpoint.