class Aws::SecurityHub::Types::AwsApiGatewayV2ApiDetails

Contains information about a version 2 API in Amazon API Gateway.

@note When making an API call, you may pass AwsApiGatewayV2ApiDetails

data as a hash:

    {
      api_endpoint: "NonEmptyString",
      api_id: "NonEmptyString",
      api_key_selection_expression: "NonEmptyString",
      created_date: "NonEmptyString",
      description: "NonEmptyString",
      version: "NonEmptyString",
      name: "NonEmptyString",
      protocol_type: "NonEmptyString",
      route_selection_expression: "NonEmptyString",
      cors_configuration: {
        allow_origins: ["NonEmptyString"],
        allow_credentials: false,
        expose_headers: ["NonEmptyString"],
        max_age: 1,
        allow_methods: ["NonEmptyString"],
        allow_headers: ["NonEmptyString"],
      },
    }

@!attribute [rw] api_endpoint

The URI of the API.

Uses the format ` <api-id>.execute-api.<region>.amazonaws.com`

The stage name is typically appended to the URI to form a complete
path to a deployed API stage.
@return [String]

@!attribute [rw] api_id

The identifier of the API.
@return [String]

@!attribute [rw] api_key_selection_expression

An API key selection expression. Supported only for WebSocket APIs.
@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] description

A description of the API.
@return [String]

@!attribute [rw] version

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

@!attribute [rw] name

The name of the API.
@return [String]

@!attribute [rw] protocol_type

The API protocol for the API.

Valid values: `WEBSOCKET` \| `HTTP`
@return [String]

@!attribute [rw] route_selection_expression

The route selection expression for the API.

For HTTP APIs, must be `$\{request.method\} $\{request.path\}`. This
is the default value for HTTP APIs.

For WebSocket APIs, there is no default value.
@return [String]

@!attribute [rw] cors_configuration

A cross-origin resource sharing (CORS) configuration. Supported only
for HTTP APIs.
@return [Types::AwsCorsConfiguration]

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

Constants

SENSITIVE