class
Amazonite::ApiGateway::EndpointConfiguration
- Amazonite::ApiGateway::EndpointConfiguration
- Reference
- Object
Overview
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.
Included Modules
- JSON::Serializable
Defined in:
api_gateway/endpoint_configuration.crConstructors
- .new(pull : JSON::PullParser)
- .new(types : Array(EndpointType) | Nil = nil, ip_address_type : IpAddressType | Nil = nil, vpc_endpoint_ids : Array(String) | Nil = nil)
- .new(*, __pull_for_json_serializable pull : JSON::PullParser)
Instance Method Summary
-
#==(other : self)
Returns
trueif this reference is the same as other. -
#hash(hasher)
See
Object#hash(hasher) -
#ip_address_type : IpAddressType | Nil
The IP address types that can invoke an API (RestApi) or a DomainName.
-
#ip_address_type=(ip_address_type : IpAddressType | Nil)
The IP address types that can invoke an API (RestApi) or a DomainName.
-
#types : Array(EndpointType) | Nil
A list of endpoint types of an API (RestApi) or its custom domain name (DomainName).
-
#types=(types : Array(EndpointType) | Nil)
A list of endpoint types of an API (RestApi) or its custom domain name (DomainName).
- #validate! : Nil
-
#vpc_endpoint_ids : Array(String) | Nil
A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes.
-
#vpc_endpoint_ids=(vpc_endpoint_ids : Array(String) | Nil)
A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes.
Constructor Detail
Instance Method Detail
Returns true if this reference is the same as other. Invokes same?.
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.
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.
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.
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.
A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only
supported for PRIVATE endpoint type.
A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only
supported for PRIVATE endpoint type.