class Amazonite::ApiGateway::RestApi

• Amazonite::ApiGateway::RestApi
• Reference
• Object

Overview

Represents a REST API.

Included Modules

• JSON::Serializable

Defined in:

api_gateway/rest_api.cr

Constructors

• .new(pull : JSON::PullParser)
• .new(id : String | Nil = nil, name : String | Nil = nil, description : String | Nil = nil, created_date : Time | Nil = nil, version : String | Nil = nil, warnings : Array(String) | Nil = nil, binary_media_types : Array(String) | Nil = nil, minimum_compression_size : Int32 | Nil = nil, api_key_source : ApiKeySourceType | Nil = nil, endpoint_configuration : EndpointConfiguration | Nil = nil, policy : String | Nil = nil, tags : Hash(String, String) | Nil = nil, disable_execute_api_endpoint : Bool | Nil = nil, root_resource_id : String | Nil = nil, security_policy : SecurityPolicy | Nil = nil, endpoint_access_mode : EndpointAccessMode | Nil = nil, api_status : ApiStatus | Nil = nil, api_status_message : String | Nil = nil)
• .new(*, __pull_for_json_serializable pull : JSON::PullParser)

Instance Method Summary

• #==(other : self)

  Returns true if this reference is the same as other.

• #api_key_source : ApiKeySourceType | Nil

  The source of the API key for metering requests according to a usage plan.

• #api_key_source=(api_key_source : ApiKeySourceType | Nil)

  The source of the API key for metering requests according to a usage plan.

• #api_status : ApiStatus | Nil

  The ApiStatus of the RestApi.

• #api_status=(api_status : ApiStatus | Nil)

  The ApiStatus of the RestApi.

• #api_status_message : String | Nil

  The status message of the RestApi.

• #api_status_message=(api_status_message : String | Nil)

  The status message of the RestApi.

• #binary_media_types : Array(String) | Nil

  The list of binary media types supported by the RestApi.

• #binary_media_types=(binary_media_types : Array(String) | Nil)

  The list of binary media types supported by the RestApi.

• #created_date : Time | Nil

  The timestamp when the API was created.

• #created_date=(created_date : Time | Nil)

  The timestamp when the API was created.

• #description : String | Nil

  The API's description.

• #description=(description : String | Nil)

  The API's description.

• #disable_execute_api_endpoint : Bool | Nil

  Specifies whether clients can invoke your API by using the default execute-api endpoint.

• #disable_execute_api_endpoint=(disable_execute_api_endpoint : Bool | Nil)

  Specifies whether clients can invoke your API by using the default execute-api endpoint.

• #endpoint_access_mode : EndpointAccessMode | Nil

  The endpoint access mode of the RestApi.

• #endpoint_access_mode=(endpoint_access_mode : EndpointAccessMode | Nil)

  The endpoint access mode of the RestApi.

• #endpoint_configuration : EndpointConfiguration | Nil

  The endpoint configuration of this RestApi showing the endpoint types and IP address types of the API.

• #endpoint_configuration=(endpoint_configuration : EndpointConfiguration | Nil)

  The endpoint configuration of this RestApi showing the endpoint types and IP address types of the API.

• #hash(hasher)

  See Object#hash(hasher)

• #id : String | Nil

  The API's identifier.

• #id=(id : String | Nil)

  The API's identifier.

• #minimum_compression_size : Int32 | Nil

  A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API.

• #minimum_compression_size=(minimum_compression_size : Int32 | Nil)

  A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API.

• #name : String | Nil

  The API's name.

• #name=(name : String | Nil)

  The API's name.

• #policy : String | Nil

  A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

• #policy=(policy : String | Nil)

  A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

• #root_resource_id : String | Nil

  The API's root resource ID.

• #root_resource_id=(root_resource_id : String | Nil)

  The API's root resource ID.

• #security_policy : SecurityPolicy | Nil

  The Transport Layer Security (TLS) version + cipher suite for this RestApi.

• #security_policy=(security_policy : SecurityPolicy | Nil)

  The Transport Layer Security (TLS) version + cipher suite for this RestApi.

• #tags : Hash(String, String) | Nil

  The collection of tags.

• #tags=(tags : Hash(String, String) | Nil)

  The collection of tags.

• #validate! : Nil
• #version : String | Nil

  A version identifier for the API.

• #version=(version : String | Nil)

  A version identifier for the API.

• #warnings : Array(String) | Nil

  The warning messages reported when failonwarnings is turned on during API import.

• #warnings=(warnings : Array(String) | Nil)

  The warning messages reported when failonwarnings is turned on during API import.

Constructor Detail

Instance Method Detail