Class: Aws::SecurityHub::Types::AwsApiGatewayRestApiDetails
- Inherits:
-
Struct
- Object
- Struct
- Aws::SecurityHub::Types::AwsApiGatewayRestApiDetails
- Defined in:
- gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb
Overview
When making an API call, you may pass AwsApiGatewayRestApiDetails data as a hash:
{
id: "NonEmptyString",
name: "NonEmptyString",
description: "NonEmptyString",
created_date: "NonEmptyString",
version: "NonEmptyString",
binary_media_types: ["NonEmptyString"],
minimum_compression_size: 1,
api_key_source: "NonEmptyString",
endpoint_configuration: {
types: ["NonEmptyString"],
},
}
contains information about a REST API in version 1 of Amazon API Gateway.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#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 REST API.
-
#created_date ⇒ String
Indicates when the API was created.
-
#description ⇒ String
A description of the REST API.
-
#endpoint_configuration ⇒ Types::AwsApiGatewayEndpointConfiguration
The endpoint configuration of the REST API.
-
#id ⇒ String
The identifier of the REST API.
-
#minimum_compression_size ⇒ Integer
The minimum size in bytes of a payload before compression is enabled.
-
#name ⇒ String
The name of the REST API.
-
#version ⇒ String
The version identifier for the REST API.
Instance Attribute Details
#api_key_source ⇒ String
The source of the API key for metering requests according to a usage plan.
HEADER
indicates whether to read the API key from the X-API-Key
header of a request.
AUTHORIZER
indicates whether to read the API key from the
UsageIdentifierKey
from a custom authorizer.
879 880 881 882 883 884 885 886 887 888 889 890 891 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 879 class AwsApiGatewayRestApiDetails < Struct.new( :id, :name, :description, :created_date, :version, :binary_media_types, :minimum_compression_size, :api_key_source, :endpoint_configuration) SENSITIVE = [] include Aws::Structure end |
#binary_media_types ⇒ Array<String>
The list of binary media types supported by the REST API.
879 880 881 882 883 884 885 886 887 888 889 890 891 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 879 class AwsApiGatewayRestApiDetails < Struct.new( :id, :name, :description, :created_date, :version, :binary_media_types, :minimum_compression_size, :api_key_source, :endpoint_configuration) SENSITIVE = [] include Aws::Structure end |
#created_date ⇒ String
Indicates when the API was created.
Uses the date-time
format specified in RFC 3339 section 5.6,
Internet Date/Time Format. The value cannot contain spaces. For
example, 2020-03-22T13:22:13.933Z
.
879 880 881 882 883 884 885 886 887 888 889 890 891 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 879 class AwsApiGatewayRestApiDetails < Struct.new( :id, :name, :description, :created_date, :version, :binary_media_types, :minimum_compression_size, :api_key_source, :endpoint_configuration) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
A description of the REST API.
879 880 881 882 883 884 885 886 887 888 889 890 891 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 879 class AwsApiGatewayRestApiDetails < Struct.new( :id, :name, :description, :created_date, :version, :binary_media_types, :minimum_compression_size, :api_key_source, :endpoint_configuration) SENSITIVE = [] include Aws::Structure end |
#endpoint_configuration ⇒ Types::AwsApiGatewayEndpointConfiguration
The endpoint configuration of the REST API.
879 880 881 882 883 884 885 886 887 888 889 890 891 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 879 class AwsApiGatewayRestApiDetails < Struct.new( :id, :name, :description, :created_date, :version, :binary_media_types, :minimum_compression_size, :api_key_source, :endpoint_configuration) SENSITIVE = [] include Aws::Structure end |
#id ⇒ String
The identifier of the REST API.
879 880 881 882 883 884 885 886 887 888 889 890 891 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 879 class AwsApiGatewayRestApiDetails < Struct.new( :id, :name, :description, :created_date, :version, :binary_media_types, :minimum_compression_size, :api_key_source, :endpoint_configuration) SENSITIVE = [] include Aws::Structure end |
#minimum_compression_size ⇒ Integer
The minimum size in bytes of a payload before compression is enabled.
If null
, then compression is disabled.
If 0, then all payloads are compressed.
879 880 881 882 883 884 885 886 887 888 889 890 891 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 879 class AwsApiGatewayRestApiDetails < Struct.new( :id, :name, :description, :created_date, :version, :binary_media_types, :minimum_compression_size, :api_key_source, :endpoint_configuration) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name of the REST API.
879 880 881 882 883 884 885 886 887 888 889 890 891 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 879 class AwsApiGatewayRestApiDetails < Struct.new( :id, :name, :description, :created_date, :version, :binary_media_types, :minimum_compression_size, :api_key_source, :endpoint_configuration) SENSITIVE = [] include Aws::Structure end |
#version ⇒ String
The version identifier for the REST API.
879 880 881 882 883 884 885 886 887 888 889 890 891 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 879 class AwsApiGatewayRestApiDetails < Struct.new( :id, :name, :description, :created_date, :version, :binary_media_types, :minimum_compression_size, :api_key_source, :endpoint_configuration) SENSITIVE = [] include Aws::Structure end |