interface EndpointConfigurationProperty

Language	Type name
.NET	Amazon.CDK.AWS.APIGateway.CfnRestApi.EndpointConfigurationProperty
Java	software.amazon.awscdk.services.apigateway.CfnRestApi.EndpointConfigurationProperty
Python	aws_cdk.aws_apigateway.CfnRestApi.EndpointConfigurationProperty
TypeScript	@aws-cdk/aws-apigateway » CfnRestApi » EndpointConfigurationProperty

The EndpointConfiguration property type specifies the endpoint types of a REST API.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as apigateway from '@aws-cdk/aws-apigateway';
const endpointConfigurationProperty: apigateway.CfnRestApi.EndpointConfigurationProperty = {
  types: ['types'],
  vpcEndpointIds: ['vpcEndpointIds'],
};

Properties

Name	Type	Description
types?	string[]	A list of endpoint types of an API (RestApi) or its custom domain name (DomainName).
vpcEndpointIds?	string[]	A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes.

---

types?

Type: string[] (optional)

A list of endpoint types of an API (RestApi) or its custom domain name (DomainName).

For an edge-optimized API and its custom domain name, the endpoint type is "EDGE" . For a regional API and its custom domain name, the endpoint type is REGIONAL . For a private API, the endpoint type is PRIVATE .

---

vpcEndpointIds?

Type: string[] (optional)

A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes.

It is only supported for PRIVATE endpoint type.