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

Inherits:

Struct

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

Includes:

Structure

Defined in:

lib/aws-sdk-apigateway/types.rb

Overview

Note:

When making an API call, you may pass EndpointConfiguration data as a 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.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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>)

# File 'lib/aws-sdk-apigateway/types.rb', line 2762

class EndpointConfiguration < Struct.new(
  :types,
  :vpc_endpoint_ids)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-apigateway/types.rb', line 2762

class EndpointConfiguration < Struct.new(
  :types,
  :vpc_endpoint_ids)
  SENSITIVE = []
  include Aws::Structure
end