RestApiEndpointConfiguration

data class RestApiEndpointConfiguration(val ipAddressType: String? = null, val types: List<String>? = null, val vpcEndpointIds: List<String>? = null)

The `EndpointConfiguration` property type specifies the endpoint types of a REST API. `EndpointConfiguration` is a property of the AWS::ApiGateway::RestApi resource.

Constructors

Link copied to clipboard
constructor(ipAddressType: String? = null, types: List<String>? = null, vpcEndpointIds: List<String>? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val ipAddressType: String? = null

The IP address types that can invoke an API (RestApi). Use ipv4 to allow only IPv4 addresses to invoke an API, or use dualstack to allow both IPv4 and IPv6 addresses to invoke an API. For the PRIVATE endpoint type, only dualstack is supported.

Link copied to clipboard
val types: List<String>? = null

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 .

Link copied to clipboard
val vpcEndpointIds: List<String>? = null

A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint type.