interface EndpointConfiguration

Language	Type name
.NET	Amazon.CDK.AWS.APIGateway.EndpointConfiguration
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#EndpointConfiguration
Java	software.amazon.awscdk.services.apigateway.EndpointConfiguration
Python	aws_cdk.aws_apigateway.EndpointConfiguration
TypeScript (source)	aws-cdk-lib » aws_apigateway » EndpointConfiguration

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

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

Example

declare const someEndpoint: ec2.IVpcEndpoint;

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

Properties

Name	Type	Description
types	EndpointType[]	A list of endpoint types of an API or its custom domain name.
ipAddressType?	IpAddressType	The IP address types that can invoke the API.
vpcEndpoints?	IVpcEndpoint[]	A list of VPC Endpoints against which to create Route53 ALIASes.

---

types

Type: EndpointType[]

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

---

ipAddressType?

Type: IpAddressType (optional, default: undefined - AWS default is DUAL_STACK for private API, IPV4 for all other APIs.)

The IP address types that can invoke the API.

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

---

vpcEndpoints?

Type: IVpcEndpoint[] (optional, default: no ALIASes are created for the endpoint.)

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