class Aws::SecurityHub::Types::AwsApiGatewayRestApiDetails

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

@note 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"],
      },
    }

@!attribute [rw] id

The identifier of the REST API.
@return [String]

@!attribute [rw] name

The name of the REST API.
@return [String]

@!attribute [rw] description

A description of the REST API.
@return [String]

@!attribute [rw] created_date

Indicates when the API was created.

Uses the `date-time` format specified in [RFC 3339 section 5.6,
Internet Date/Time Format][1]. The value cannot contain spaces. For
example, `2020-03-22T13:22:13.933Z`.

[1]: https://tools.ietf.org/html/rfc3339#section-5.6
@return [String]

@!attribute [rw] version

The version identifier for the REST API.
@return [String]

@!attribute [rw] binary_media_types

The list of binary media types supported by the REST API.
@return [Array<String>]

@!attribute [rw] minimum_compression_size

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.
@return [Integer]

@!attribute [rw] api_key_source

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.
@return [String]

@!attribute [rw] endpoint_configuration

The endpoint configuration of the REST API.
@return [Types::AwsApiGatewayEndpointConfiguration]

@see docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/AwsApiGatewayRestApiDetails AWS API Documentation

Constants

SENSITIVE