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

Contains information about a REST API in version 1 of Amazon API Gateway.

See Also:

• AWS API Documentation

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

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1868

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.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1868

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.

This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

• YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

• YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

• YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1868

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.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1868

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.

Returns:

• (Types::AwsApiGatewayEndpointConfiguration)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1868

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.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1868

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.

Returns:

• (Integer)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1868

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.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1868

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.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1868

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