EndpointConfiguration Struct
The endpoint configuration of a REST API, including VPCs and endpoint types.
EndpointConfiguration is a property of the AWS::ApiGateway::RestApi resource.
Example
ts
declare const someEndpoint: ec2.IVpcEndpoint;
const api = new apigateway.RestApi(this, 'api', {
endpointConfiguration: {
types: [ apigateway.EndpointType.PRIVATE ],
vpcEndpoints: [ someEndpoint ]
}
});
Properties
ipAddressTypeIpAddressTypeip_address_typeIpAddressTypeipAddressTypeIpAddressTypeIpAddressTypeIpAddressTypeIpAddressTypeIpAddressType#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.
vpcEndpointsIVpcEndpoint[]vpc_endpointstyping.List[IVpcEndpoint]vpcEndpointsList<IVpcEndpoint>VpcEndpointsIVpcEndpoint[]VpcEndpoints*[]IVpcEndpoint#A list of VPC Endpoints against which to create Route53 ALIASes.
Default: no ALIASes are created for the endpoint.