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

Class: Aws::APIGateway::Types::CreateRestApiRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateRestApiRequest as input to an Aws::Client method, you can use a vanilla 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
  },
}

The POST Request to add a new RestApi resource to your collection.

Instance Attribute Summary collapse

Instance Attribute Details

#api_key_sourceString

The source of the API key for metring 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

Returns:

  • (String)

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

#binary_media_typesArray<String>

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

Returns:

  • (Array<String>)

    The list of binary media types supported by the RestApi.

#clone_fromString

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

Returns:

  • (String)

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

#descriptionString

The description of the RestApi.

Returns:

  • (String)

    The description of the RestApi.

#endpoint_configurationTypes::EndpointConfiguration

The endpoint configuration of this RestApi showing the endpoint types of the API.

Returns:

#minimum_compression_sizeInteger

A nullable integer used to enable (non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable (null) compression on an API. When compression is enabled, compression or decompression are not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

Returns:

  • (Integer)

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

#nameString

The name of the RestApi.

Returns:

  • (String)

    The name of the RestApi.

#versionString

A version identifier for the API.

Returns:

  • (String)

    A version identifier for the API.