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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/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.

Instance Attribute Summary collapse

Instance Attribute Details

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


2664
2665
2666
2667
2668
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2664

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

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


2664
2665
2666
2667
2668
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2664

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