pulumi-aws-kotlin/com.pulumi.aws.apigateway.kotlin.outputs/RestApiEndpointConfiguration

RestApiEndpointConfiguration

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

Constructors

constructor(ipAddressType: String? = null, types: String, vpcEndpointIds: List<String>? = null)

Types

Companion

object Companion

Properties

ipAddressType

val ipAddressType: String? = null

The IP address types that can invoke an API (RestApi). Valid values: ipv4, dualstack. 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. The provider performs drift detection for this argument only when the value is provided.

types

val types: String

List of endpoint types. This resource currently only supports managing a single value. Valid values: EDGE, REGIONAL or PRIVATE. If unspecified, defaults to EDGE. If set to PRIVATE recommend to set put_rest_api_mode = merge to not cause the endpoints and associated Route53 records to be deleted. Refer to the documentation for more information on the difference between edge-optimized and regional APIs.

vpcEndpointIds

val vpcEndpointIds: List<String>? = null

Set of VPC Endpoint identifiers. It is only supported for PRIVATE endpoint type. If importing an OpenAPI specification via the body argument, this corresponds to the x-amazon-apigateway-endpoint-configuration extension vpcEndpointIds property. If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.