You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::APIGateway::Types::EndpointConfiguration

Inherits:

Struct

Object
Struct
Aws::APIGateway::Types::EndpointConfiguration

show all

Defined in:: (unknown)

Overview

Note:

When passing EndpointConfiguration as input to an Aws::Client method, you can use a vanilla Hash:

{
  types: ["REGIONAL"], # accepts REGIONAL, EDGE, PRIVATE
  vpc_endpoint_ids: ["String"],
}

The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.

Returned by:

Instance Attribute Summary collapse

#types ⇒ Array<String>
A list of endpoint types of an API (RestApi) or its custom domain name (DomainName).
#vpc_endpoint_ids ⇒ Array<String>
A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes.

Instance Attribute Details

#types ⇒ `Array<String>`

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.

Returns:

(Array<String>) —
A list of endpoint types of an API (RestApi) or its custom domain name (DomainName).

#vpc_endpoint_ids ⇒ `Array<String>`

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