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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb

Overview

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

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#api_endpointString

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)


1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1147

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_idString

The identifier of the API.

Returns:

  • (String)


1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1147

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_expressionString

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

Returns:

  • (String)


1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1147

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_configurationTypes::AwsCorsConfiguration

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



1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1147

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_dateString

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)


1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1147

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

#descriptionString

A description of the API.

Returns:

  • (String)


1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1147

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

#nameString

The name of the API.

Returns:

  • (String)


1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1147

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_typeString

The API protocol for the API.

Valid values: WEBSOCKET | HTTP

Returns:

  • (String)


1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1147

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_expressionString

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)


1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1147

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

#versionString

The version identifier for the API.

Returns:

  • (String)


1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1147

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