Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://docs.aws.amazon.com/sdkforruby/api/Aws/APIGateway/Types/CreateRestApiRequest.html below:

CreateRestApiRequest — AWS SDK for Ruby V2

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::CreateRestApiRequest

show all

Defined in:

(unknown)

When passing CreateRestApiRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "String",   description: "String",
  version: "String",
  clone_from: "String",
  binary_media_types: ["String"],
  minimum_compression_size: 1,
  api_key_source: "HEADER",   endpoint_configuration: {
    types: ["REGIONAL"],     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.

• #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

  [Required] 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.

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.

Possible values:

• HEADER
• AUTHORIZER

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

The ID of the RestApi that you want to clone from.

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" target="_parent" title="api_id">https://`{api_id</a>">api_id">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.

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.

[Required] The name of the RestApi.

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

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.

A version identifier for the API.

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4