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

Inherits:

Struct

• Object
• Struct
• Aws::SecurityHub::Types::AwsApiGatewayV2ApiDetails

Defined in:

gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #api_endpoint ⇒ String

  The URI of the API.

• #api_id ⇒ String

  The identifier of the API.

• #api_key_selection_expression ⇒ String

  An API key selection expression.

• #cors_configuration ⇒ Types::AwsCorsConfiguration

  A cross-origin resource sharing (CORS) configuration.

• #created_date ⇒ String

  Indicates when the API was created.

• #description ⇒ String

  A description of the API.

• #name ⇒ String

  The name of the API.

• #protocol_type ⇒ String

  The API protocol for the API.

• #route_selection_expression ⇒ String

  The route selection expression for the API.

• #version ⇒ String

  The version identifier for the API.

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)

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

class AwsApiGatewayV2ApiDetails < Struct.new(
  :api_endpoint,
  :api_id,
  :api_key_selection_expression,
  :created_date,
  :description,
  :version,
  :name,
  :protocol_type,
  :route_selection_expression,
  :cors_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#api_id ⇒ String

The identifier of the API.

Returns:

• (String)

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

class AwsApiGatewayV2ApiDetails < Struct.new(
  :api_endpoint,
  :api_id,
  :api_key_selection_expression,
  :created_date,
  :description,
  :version,
  :name,
  :protocol_type,
  :route_selection_expression,
  :cors_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#api_key_selection_expression ⇒ String

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

Returns:

• (String)

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

class AwsApiGatewayV2ApiDetails < Struct.new(
  :api_endpoint,
  :api_id,
  :api_key_selection_expression,
  :created_date,
  :description,
  :version,
  :name,
  :protocol_type,
  :route_selection_expression,
  :cors_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#cors_configuration ⇒ Types::AwsCorsConfiguration

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

Returns:

• (Types::AwsCorsConfiguration)

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

class AwsApiGatewayV2ApiDetails < Struct.new(
  :api_endpoint,
  :api_id,
  :api_key_selection_expression,
  :created_date,
  :description,
  :version,
  :name,
  :protocol_type,
  :route_selection_expression,
  :cors_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 2100

class AwsApiGatewayV2ApiDetails < Struct.new(
  :api_endpoint,
  :api_id,
  :api_key_selection_expression,
  :created_date,
  :description,
  :version,
  :name,
  :protocol_type,
  :route_selection_expression,
  :cors_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the API.

Returns:

• (String)

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

class AwsApiGatewayV2ApiDetails < Struct.new(
  :api_endpoint,
  :api_id,
  :api_key_selection_expression,
  :created_date,
  :description,
  :version,
  :name,
  :protocol_type,
  :route_selection_expression,
  :cors_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the API.

Returns:

• (String)

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

class AwsApiGatewayV2ApiDetails < Struct.new(
  :api_endpoint,
  :api_id,
  :api_key_selection_expression,
  :created_date,
  :description,
  :version,
  :name,
  :protocol_type,
  :route_selection_expression,
  :cors_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#protocol_type ⇒ String

The API protocol for the API.

Valid values: WEBSOCKET | HTTP

Returns:

• (String)

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

class AwsApiGatewayV2ApiDetails < Struct.new(
  :api_endpoint,
  :api_id,
  :api_key_selection_expression,
  :created_date,
  :description,
  :version,
  :name,
  :protocol_type,
  :route_selection_expression,
  :cors_configuration)
  SENSITIVE = []
  include Aws::Structure
end

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

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

class AwsApiGatewayV2ApiDetails < Struct.new(
  :api_endpoint,
  :api_id,
  :api_key_selection_expression,
  :created_date,
  :description,
  :version,
  :name,
  :protocol_type,
  :route_selection_expression,
  :cors_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ String

The version identifier for the API.

Returns:

• (String)

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

class AwsApiGatewayV2ApiDetails < Struct.new(
  :api_endpoint,
  :api_id,
  :api_key_selection_expression,
  :created_date,
  :description,
  :version,
  :name,
  :protocol_type,
  :route_selection_expression,
  :cors_configuration)
  SENSITIVE = []
  include Aws::Structure
end