You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SecurityHub::Types::AwsApiGatewayV2ApiDetails

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing AwsApiGatewayV2ApiDetails as input to an Aws::Client method, you can use a vanilla 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"],
  },
}

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

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#api_endpoint ⇒ String

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.

Returns:

  • (String) —

    The URI of the API.

#api_id ⇒ String

The identifier of the API.

Returns:

  • (String) —

    The identifier of the API.

#api_key_selection_expression ⇒ String

An API key selection expression. Supported only for WebSocket APIs.

Returns:

  • (String) —

    An API key selection expression.

#cors_configuration ⇒ Types::AwsCorsConfiguration

A cross-origin resource sharing (CORS) configuration. Supported only for HTTP APIs.

Returns:

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

Returns:

  • (String) —

    Indicates when the API was created.

#description ⇒ String

A description of the API.

Returns:

  • (String) —

    A description of the API.

#name ⇒ String

The name of the API.

Returns:

  • (String) —

    The name of the API.

#protocol_type ⇒ String

The API protocol for the API.

Valid values: WEBSOCKET | HTTP

Returns:

  • (String) —

    The API protocol for the API.

#route_selection_expression ⇒ String

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.

Returns:

  • (String) —

    The route selection expression for the API.

#version ⇒ String

The version identifier for the API.

Returns:

  • (String) —

    The version identifier for the API.