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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb

Overview

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
  },
  policy: "String",
}

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 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)


1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1207

class CreateRestApiRequest < Struct.new(
  :name,
  :description,
  :version,
  :clone_from,
  :binary_media_types,
  :minimum_compression_size,
  :api_key_source,
  :endpoint_configuration,
  :policy)
  include Aws::Structure
end

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


1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1207

class CreateRestApiRequest < Struct.new(
  :name,
  :description,
  :version,
  :clone_from,
  :binary_media_types,
  :minimum_compression_size,
  :api_key_source,
  :endpoint_configuration,
  :policy)
  include Aws::Structure
end

#clone_fromString

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

Returns:

  • (String)


1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1207

class CreateRestApiRequest < Struct.new(
  :name,
  :description,
  :version,
  :clone_from,
  :binary_media_types,
  :minimum_compression_size,
  :api_key_source,
  :endpoint_configuration,
  :policy)
  include Aws::Structure
end

#descriptionString

The description of the RestApi.

Returns:

  • (String)


1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1207

class CreateRestApiRequest < Struct.new(
  :name,
  :description,
  :version,
  :clone_from,
  :binary_media_types,
  :minimum_compression_size,
  :api_key_source,
  :endpoint_configuration,
  :policy)
  include Aws::Structure
end

#endpoint_configurationTypes::EndpointConfiguration

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



1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1207

class CreateRestApiRequest < Struct.new(
  :name,
  :description,
  :version,
  :clone_from,
  :binary_media_types,
  :minimum_compression_size,
  :api_key_source,
  :endpoint_configuration,
  :policy)
  include Aws::Structure
end

#minimum_compression_sizeInteger

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)


1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1207

class CreateRestApiRequest < Struct.new(
  :name,
  :description,
  :version,
  :clone_from,
  :binary_media_types,
  :minimum_compression_size,
  :api_key_source,
  :endpoint_configuration,
  :policy)
  include Aws::Structure
end

#nameString

[Required] The name of the RestApi.

Returns:

  • (String)


1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1207

class CreateRestApiRequest < Struct.new(
  :name,
  :description,
  :version,
  :clone_from,
  :binary_media_types,
  :minimum_compression_size,
  :api_key_source,
  :endpoint_configuration,
  :policy)
  include Aws::Structure
end

#policyString

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

Returns:

  • (String)


1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1207

class CreateRestApiRequest < Struct.new(
  :name,
  :description,
  :version,
  :clone_from,
  :binary_media_types,
  :minimum_compression_size,
  :api_key_source,
  :endpoint_configuration,
  :policy)
  include Aws::Structure
end

#versionString

A version identifier for the API.

Returns:

  • (String)


1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1207

class CreateRestApiRequest < Struct.new(
  :name,
  :description,
  :version,
  :clone_from,
  :binary_media_types,
  :minimum_compression_size,
  :api_key_source,
  :endpoint_configuration,
  :policy)
  include Aws::Structure
end