class
Amazonite::ApiGateway::CreateRestApiRequest
- Amazonite::ApiGateway::CreateRestApiRequest
- Reference
- Object
Overview
The POST Request to add a new RestApi resource to your collection.
Included Modules
- JSON::Serializable
Defined in:
api_gateway/create_rest_api_request.crConstructors
- .new(pull : JSON::PullParser)
- .new(name : String, description : String | Nil = nil, version : String | Nil = nil, clone_from : 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, security_policy : SecurityPolicy | Nil = nil, endpoint_access_mode : EndpointAccessMode | Nil = nil)
Instance Method Summary
-
#==(other : self)
Returns
trueif 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.
-
#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.
-
#clone_from : String | Nil
The ID of the RestApi that you want to clone from.
-
#clone_from=(clone_from : String | Nil)
The ID of the RestApi that you want to clone from.
-
#description : String | Nil
The description of the RestApi.
-
#description=(description : String | Nil)
The description of the RestApi.
-
#disable_execute_api_endpoint : Bool | Nil
Specifies whether clients can invoke your API by using the default
execute-apiendpoint. -
#disable_execute_api_endpoint=(disable_execute_api_endpoint : Bool | Nil)
Specifies whether clients can invoke your API by using the default
execute-apiendpoint. -
#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) -
#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
The name of the RestApi.
-
#name=(name : String)
The name of the RestApi.
-
#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.
-
#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 key-value map of strings.
-
#tags=(tags : Hash(String, String) | Nil)
The key-value map of strings.
- #validate! : Nil
-
#version : String | Nil
A version identifier for the API.
-
#version=(version : String | Nil)
A version identifier for the API.
Constructor Detail
Instance Method Detail
Returns true if this reference is the same as other. Invokes same?.
The source of the API key for metering requests according to a usage plan. Valid values are:
HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the
API key from the UsageIdentifierKey from a custom authorizer.
The source of the API key for metering requests according to a usage plan. Valid values are:
HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the
API key from the UsageIdentifierKey from a custom authorizer.
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
Specifies whether clients can invoke your API by using the default execute-api endpoint. By
default, clients can invoke your API with the default
https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a
custom domain name to invoke your API, disable the default endpoint
Specifies whether clients can invoke your API by using the default execute-api endpoint. By
default, clients can invoke your API with the default
https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a
custom domain name to invoke your API, disable the default endpoint
The endpoint access mode of the RestApi. Only available for RestApis that use security policies
that start with SecurityPolicy_.
The endpoint access mode of the RestApi. Only available for RestApis that use security policies
that start with SecurityPolicy_.
The endpoint configuration of this RestApi showing the endpoint types and IP address types of the API.
The endpoint configuration of this RestApi showing the endpoint types and IP address types of the API.
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. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
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. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
The Transport Layer Security (TLS) version + cipher suite for this RestApi.
The Transport Layer Security (TLS) version + cipher suite for this RestApi.
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up
to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up
to 128 characters and must not start with aws:. The tag value can be up to 256 characters.