Class: Aws::APIGateway::Types::CreateRestApiRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::CreateRestApiRequest
- Defined in:
- gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb
Overview
When making an API call, you may pass CreateRestApiRequest data as a hash:
{
name: "String", # required
description: "String",
version: "String",
clone_from: "String",
binary_media_types: ["String"],
minimum_compression_size: 1,
api_key_source: "HEADER", # accepts HEADER, AUTHORIZER
endpoint_configuration: {
types: ["REGIONAL"], # accepts REGIONAL, EDGE, PRIVATE
vpc_endpoint_ids: ["String"],
},
policy: "String",
tags: {
"String" => "String",
},
disable_execute_api_endpoint: false,
}
The POST Request to add a new RestApi resource to your collection.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#api_key_source ⇒ String
The source of the API key for metering requests according to a usage plan.
-
#binary_media_types ⇒ Array<String>
The list of binary media types supported by the RestApi.
-
#clone_from ⇒ String
The ID of the RestApi that you want to clone from.
-
#description ⇒ String
The description of the RestApi.
-
#disable_execute_api_endpoint ⇒ Boolean
Specifies whether clients can invoke your API by using the default
execute-api
endpoint. -
#endpoint_configuration ⇒ Types::EndpointConfiguration
The endpoint configuration of this RestApi showing the endpoint types of the API.
-
#minimum_compression_size ⇒ Integer
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.
-
#policy ⇒ String
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
-
#tags ⇒ Hash<String,String>
The key-value map of strings.
-
#version ⇒ String
A version identifier for the API.
Instance Attribute Details
#api_key_source ⇒ String
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.
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1221 class CreateRestApiRequest < Struct.new( :name, :description, :version, :clone_from, :binary_media_types, :minimum_compression_size, :api_key_source, :endpoint_configuration, :policy, :tags, :disable_execute_api_endpoint) SENSITIVE = [] include Aws::Structure end |
#binary_media_types ⇒ Array<String>
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1221 class CreateRestApiRequest < Struct.new( :name, :description, :version, :clone_from, :binary_media_types, :minimum_compression_size, :api_key_source, :endpoint_configuration, :policy, :tags, :disable_execute_api_endpoint) SENSITIVE = [] include Aws::Structure end |
#clone_from ⇒ String
The ID of the RestApi that you want to clone from.
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1221 class CreateRestApiRequest < Struct.new( :name, :description, :version, :clone_from, :binary_media_types, :minimum_compression_size, :api_key_source, :endpoint_configuration, :policy, :tags, :disable_execute_api_endpoint) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
The description of the RestApi.
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1221 class CreateRestApiRequest < Struct.new( :name, :description, :version, :clone_from, :binary_media_types, :minimum_compression_size, :api_key_source, :endpoint_configuration, :policy, :tags, :disable_execute_api_endpoint) SENSITIVE = [] include Aws::Structure end |
#disable_execute_api_endpoint ⇒ Boolean
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
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1221 class CreateRestApiRequest < Struct.new( :name, :description, :version, :clone_from, :binary_media_types, :minimum_compression_size, :api_key_source, :endpoint_configuration, :policy, :tags, :disable_execute_api_endpoint) SENSITIVE = [] include Aws::Structure end |
#endpoint_configuration ⇒ Types::EndpointConfiguration
The endpoint configuration of this RestApi showing the endpoint types of the API.
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1221 class CreateRestApiRequest < Struct.new( :name, :description, :version, :clone_from, :binary_media_types, :minimum_compression_size, :api_key_source, :endpoint_configuration, :policy, :tags, :disable_execute_api_endpoint) SENSITIVE = [] include Aws::Structure end |
#minimum_compression_size ⇒ Integer
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.
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1221 class CreateRestApiRequest < Struct.new( :name, :description, :version, :clone_from, :binary_media_types, :minimum_compression_size, :api_key_source, :endpoint_configuration, :policy, :tags, :disable_execute_api_endpoint) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name of the RestApi.
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1221 class CreateRestApiRequest < Struct.new( :name, :description, :version, :clone_from, :binary_media_types, :minimum_compression_size, :api_key_source, :endpoint_configuration, :policy, :tags, :disable_execute_api_endpoint) SENSITIVE = [] include Aws::Structure end |
#policy ⇒ String
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1221 class CreateRestApiRequest < Struct.new( :name, :description, :version, :clone_from, :binary_media_types, :minimum_compression_size, :api_key_source, :endpoint_configuration, :policy, :tags, :disable_execute_api_endpoint) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Hash<String,String>
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.
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1221 class CreateRestApiRequest < Struct.new( :name, :description, :version, :clone_from, :binary_media_types, :minimum_compression_size, :api_key_source, :endpoint_configuration, :policy, :tags, :disable_execute_api_endpoint) SENSITIVE = [] include Aws::Structure end |
#version ⇒ String
A version identifier for the API.
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1221 class CreateRestApiRequest < Struct.new( :name, :description, :version, :clone_from, :binary_media_types, :minimum_compression_size, :api_key_source, :endpoint_configuration, :policy, :tags, :disable_execute_api_endpoint) SENSITIVE = [] include Aws::Structure end |