class Aws::APIGateway::Types::CreateRestApiRequest
The POST Request to add a new RestApi
resource to your collection.
@note 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, }
@!attribute [rw] name
\[Required\] The name of the RestApi. @return [String]
@!attribute [rw] description
The description of the RestApi. @return [String]
@!attribute [rw] version
A version identifier for the API. @return [String]
@!attribute [rw] clone_from
The ID of the RestApi that you want to clone from. @return [String]
@!attribute [rw] binary_media_types
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads. @return [Array<String>]
@!attribute [rw] minimum_compression_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. @return [Integer]
@!attribute [rw] api_key_source
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. @return [String]
@!attribute [rw] endpoint_configuration
The endpoint configuration of this RestApi showing the endpoint types of the API. @return [Types::EndpointConfiguration]
@!attribute [rw] policy
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration. @return [String]
@!attribute [rw] tags
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. @return [Hash<String,String>]
@!attribute [rw] disable_execute_api_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. @return [Boolean]
Constants
- SENSITIVE