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

Inherits:

Struct

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

Includes:

Structure

Defined in:

lib/aws-sdk-apigateway/types.rb

Overview

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

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

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

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 1026

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.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-apigateway/types.rb', line 1026

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.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 1026

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.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 1026

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-apigateway/types.rb', line 1026

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.

Returns:

• (Types::EndpointConfiguration)

# File 'lib/aws-sdk-apigateway/types.rb', line 1026

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.

Returns:

• (Integer)

# File 'lib/aws-sdk-apigateway/types.rb', line 1026

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.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 1026

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.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 1026

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.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-apigateway/types.rb', line 1026

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.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 1026

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