apigateway/aws.sdk.kotlin.services.apigateway.model/EndpointConfiguration

EndpointConfiguration

The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has and the IP address types that can invoke it.

Types

Builder

class Builder

Companion

object Companion

Properties

ipAddressType

val ipAddressType: IpAddressType?

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

types

val types: List<EndpointType>?

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

val vpcEndpointIds: List<String>?

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

Functions

copy

inline fun copy(block: EndpointConfiguration.Builder.() -> Unit = {}): EndpointConfiguration

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String