Class: Aws::APIGateway::Types::RestApi

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

Overview

Represents a REST API.

[Create an API][1]

Constant Summary collapse

SENSITIVE =
[]

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)


6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6426

class RestApi < Struct.new(
  :id,
  :name,
  :description,
  :created_date,
  :version,
  :warnings,
  :binary_media_types,
  :minimum_compression_size,
  :api_key_source,
  :endpoint_configuration,
  :policy,
  :tags,
  :disable_execute_api_endpoint)
  SENSITIVE = []
  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>)


6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6426

class RestApi < Struct.new(
  :id,
  :name,
  :description,
  :created_date,
  :version,
  :warnings,
  :binary_media_types,
  :minimum_compression_size,
  :api_key_source,
  :endpoint_configuration,
  :policy,
  :tags,
  :disable_execute_api_endpoint)
  SENSITIVE = []
  include Aws::Structure
end

#created_dateTime

The timestamp when the API was created.

Returns:

  • (Time)


6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6426

class RestApi < Struct.new(
  :id,
  :name,
  :description,
  :created_date,
  :version,
  :warnings,
  :binary_media_types,
  :minimum_compression_size,
  :api_key_source,
  :endpoint_configuration,
  :policy,
  :tags,
  :disable_execute_api_endpoint)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The API's description.

Returns:

  • (String)


6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6426

class RestApi < Struct.new(
  :id,
  :name,
  :description,
  :created_date,
  :version,
  :warnings,
  :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_endpointBoolean

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)


6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6426

class RestApi < Struct.new(
  :id,
  :name,
  :description,
  :created_date,
  :version,
  :warnings,
  :binary_media_types,
  :minimum_compression_size,
  :api_key_source,
  :endpoint_configuration,
  :policy,
  :tags,
  :disable_execute_api_endpoint)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_configurationTypes::EndpointConfiguration

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



6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6426

class RestApi < Struct.new(
  :id,
  :name,
  :description,
  :created_date,
  :version,
  :warnings,
  :binary_media_types,
  :minimum_compression_size,
  :api_key_source,
  :endpoint_configuration,
  :policy,
  :tags,
  :disable_execute_api_endpoint)
  SENSITIVE = []
  include Aws::Structure
end

#idString

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

Returns:

  • (String)


6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6426

class RestApi < Struct.new(
  :id,
  :name,
  :description,
  :created_date,
  :version,
  :warnings,
  :binary_media_types,
  :minimum_compression_size,
  :api_key_source,
  :endpoint_configuration,
  :policy,
  :tags,
  :disable_execute_api_endpoint)
  SENSITIVE = []
  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)


6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6426

class RestApi < Struct.new(
  :id,
  :name,
  :description,
  :created_date,
  :version,
  :warnings,
  :binary_media_types,
  :minimum_compression_size,
  :api_key_source,
  :endpoint_configuration,
  :policy,
  :tags,
  :disable_execute_api_endpoint)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The API's name.

Returns:

  • (String)


6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6426

class RestApi < Struct.new(
  :id,
  :name,
  :description,
  :created_date,
  :version,
  :warnings,
  :binary_media_types,
  :minimum_compression_size,
  :api_key_source,
  :endpoint_configuration,
  :policy,
  :tags,
  :disable_execute_api_endpoint)
  SENSITIVE = []
  include Aws::Structure
end

#policyString

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

Returns:

  • (String)


6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6426

class RestApi < Struct.new(
  :id,
  :name,
  :description,
  :created_date,
  :version,
  :warnings,
  :binary_media_types,
  :minimum_compression_size,
  :api_key_source,
  :endpoint_configuration,
  :policy,
  :tags,
  :disable_execute_api_endpoint)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

The collection of tags. Each tag element is associated with a given resource.

Returns:

  • (Hash<String,String>)


6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6426

class RestApi < Struct.new(
  :id,
  :name,
  :description,
  :created_date,
  :version,
  :warnings,
  :binary_media_types,
  :minimum_compression_size,
  :api_key_source,
  :endpoint_configuration,
  :policy,
  :tags,
  :disable_execute_api_endpoint)
  SENSITIVE = []
  include Aws::Structure
end

#versionString

A version identifier for the API.

Returns:

  • (String)


6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6426

class RestApi < Struct.new(
  :id,
  :name,
  :description,
  :created_date,
  :version,
  :warnings,
  :binary_media_types,
  :minimum_compression_size,
  :api_key_source,
  :endpoint_configuration,
  :policy,
  :tags,
  :disable_execute_api_endpoint)
  SENSITIVE = []
  include Aws::Structure
end

#warningsArray<String>

The warning messages reported when failonwarnings is turned on during API import.

Returns:

  • (Array<String>)


6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6426

class RestApi < Struct.new(
  :id,
  :name,
  :description,
  :created_date,
  :version,
  :warnings,
  :binary_media_types,
  :minimum_compression_size,
  :api_key_source,
  :endpoint_configuration,
  :policy,
  :tags,
  :disable_execute_api_endpoint)
  SENSITIVE = []
  include Aws::Structure
end