Class: Aws::SecurityHub::Types::AwsApiGatewayV2StageDetails
- Inherits:
-
Struct
- Object
- Struct
- Aws::SecurityHub::Types::AwsApiGatewayV2StageDetails
- Defined in:
- gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb
Overview
When making an API call, you may pass AwsApiGatewayV2StageDetails data as a hash:
{
client_certificate_id: "NonEmptyString",
created_date: "NonEmptyString",
description: "NonEmptyString",
default_route_settings: {
detailed_metrics_enabled: false,
logging_level: "NonEmptyString",
data_trace_enabled: false,
throttling_burst_limit: 1,
throttling_rate_limit: 1.0,
},
deployment_id: "NonEmptyString",
last_updated_date: "NonEmptyString",
route_settings: {
detailed_metrics_enabled: false,
logging_level: "NonEmptyString",
data_trace_enabled: false,
throttling_burst_limit: 1,
throttling_rate_limit: 1.0,
},
stage_name: "NonEmptyString",
stage_variables: {
"NonEmptyString" => "NonEmptyString",
},
access_log_settings: {
format: "NonEmptyString",
destination_arn: "NonEmptyString",
},
auto_deploy: false,
last_deployment_status_message: "NonEmptyString",
api_gateway_managed: false,
}
Contains information about a version 2 stage for Amazon API Gateway.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#access_log_settings ⇒ Types::AwsApiGatewayAccessLogSettings
Information about settings for logging access for the stage.
-
#api_gateway_managed ⇒ Boolean
Indicates whether the stage is managed by API Gateway.
-
#auto_deploy ⇒ Boolean
Indicates whether updates to an API automatically trigger a new deployment.
-
#client_certificate_id ⇒ String
The identifier of a client certificate for a stage.
-
#created_date ⇒ String
Indicates when the stage was created.
-
#default_route_settings ⇒ Types::AwsApiGatewayV2RouteSettings
Default route settings for the stage.
-
#deployment_id ⇒ String
The identifier of the deployment that the stage is associated with.
-
#description ⇒ String
The description of the stage.
-
#last_deployment_status_message ⇒ String
The status of the last deployment of a stage.
-
#last_updated_date ⇒ String
Indicates when the stage was most recently updated.
-
#route_settings ⇒ Types::AwsApiGatewayV2RouteSettings
The route settings for the stage.
-
#stage_name ⇒ String
The name of the stage.
-
#stage_variables ⇒ Hash<String,String>
A map that defines the stage variables for the stage.
Instance Attribute Details
#access_log_settings ⇒ Types::AwsApiGatewayAccessLogSettings
Information about settings for logging access for the stage.
1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1399 class AwsApiGatewayV2StageDetails < Struct.new( :client_certificate_id, :created_date, :description, :default_route_settings, :deployment_id, :last_updated_date, :route_settings, :stage_name, :stage_variables, :access_log_settings, :auto_deploy, :last_deployment_status_message, :api_gateway_managed) SENSITIVE = [] include Aws::Structure end |
#api_gateway_managed ⇒ Boolean
Indicates whether the stage is managed by API Gateway.
1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1399 class AwsApiGatewayV2StageDetails < Struct.new( :client_certificate_id, :created_date, :description, :default_route_settings, :deployment_id, :last_updated_date, :route_settings, :stage_name, :stage_variables, :access_log_settings, :auto_deploy, :last_deployment_status_message, :api_gateway_managed) SENSITIVE = [] include Aws::Structure end |
#auto_deploy ⇒ Boolean
Indicates whether updates to an API automatically trigger a new deployment.
1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1399 class AwsApiGatewayV2StageDetails < Struct.new( :client_certificate_id, :created_date, :description, :default_route_settings, :deployment_id, :last_updated_date, :route_settings, :stage_name, :stage_variables, :access_log_settings, :auto_deploy, :last_deployment_status_message, :api_gateway_managed) SENSITIVE = [] include Aws::Structure end |
#client_certificate_id ⇒ String
The identifier of a client certificate for a stage. Supported only for WebSocket API calls.
1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1399 class AwsApiGatewayV2StageDetails < Struct.new( :client_certificate_id, :created_date, :description, :default_route_settings, :deployment_id, :last_updated_date, :route_settings, :stage_name, :stage_variables, :access_log_settings, :auto_deploy, :last_deployment_status_message, :api_gateway_managed) SENSITIVE = [] include Aws::Structure end |
#created_date ⇒ String
Indicates when the stage 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
.
1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1399 class AwsApiGatewayV2StageDetails < Struct.new( :client_certificate_id, :created_date, :description, :default_route_settings, :deployment_id, :last_updated_date, :route_settings, :stage_name, :stage_variables, :access_log_settings, :auto_deploy, :last_deployment_status_message, :api_gateway_managed) SENSITIVE = [] include Aws::Structure end |
#default_route_settings ⇒ Types::AwsApiGatewayV2RouteSettings
Default route settings for the stage.
1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1399 class AwsApiGatewayV2StageDetails < Struct.new( :client_certificate_id, :created_date, :description, :default_route_settings, :deployment_id, :last_updated_date, :route_settings, :stage_name, :stage_variables, :access_log_settings, :auto_deploy, :last_deployment_status_message, :api_gateway_managed) SENSITIVE = [] include Aws::Structure end |
#deployment_id ⇒ String
The identifier of the deployment that the stage is associated with.
1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1399 class AwsApiGatewayV2StageDetails < Struct.new( :client_certificate_id, :created_date, :description, :default_route_settings, :deployment_id, :last_updated_date, :route_settings, :stage_name, :stage_variables, :access_log_settings, :auto_deploy, :last_deployment_status_message, :api_gateway_managed) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
The description of the stage.
1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1399 class AwsApiGatewayV2StageDetails < Struct.new( :client_certificate_id, :created_date, :description, :default_route_settings, :deployment_id, :last_updated_date, :route_settings, :stage_name, :stage_variables, :access_log_settings, :auto_deploy, :last_deployment_status_message, :api_gateway_managed) SENSITIVE = [] include Aws::Structure end |
#last_deployment_status_message ⇒ String
The status of the last deployment of a stage. Supported only if the stage has automatic deployment enabled.
1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1399 class AwsApiGatewayV2StageDetails < Struct.new( :client_certificate_id, :created_date, :description, :default_route_settings, :deployment_id, :last_updated_date, :route_settings, :stage_name, :stage_variables, :access_log_settings, :auto_deploy, :last_deployment_status_message, :api_gateway_managed) SENSITIVE = [] include Aws::Structure end |
#last_updated_date ⇒ String
Indicates when the stage was most recently updated.
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
.
1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1399 class AwsApiGatewayV2StageDetails < Struct.new( :client_certificate_id, :created_date, :description, :default_route_settings, :deployment_id, :last_updated_date, :route_settings, :stage_name, :stage_variables, :access_log_settings, :auto_deploy, :last_deployment_status_message, :api_gateway_managed) SENSITIVE = [] include Aws::Structure end |
#route_settings ⇒ Types::AwsApiGatewayV2RouteSettings
The route settings for the stage.
1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1399 class AwsApiGatewayV2StageDetails < Struct.new( :client_certificate_id, :created_date, :description, :default_route_settings, :deployment_id, :last_updated_date, :route_settings, :stage_name, :stage_variables, :access_log_settings, :auto_deploy, :last_deployment_status_message, :api_gateway_managed) SENSITIVE = [] include Aws::Structure end |
#stage_name ⇒ String
The name of the stage.
1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1399 class AwsApiGatewayV2StageDetails < Struct.new( :client_certificate_id, :created_date, :description, :default_route_settings, :deployment_id, :last_updated_date, :route_settings, :stage_name, :stage_variables, :access_log_settings, :auto_deploy, :last_deployment_status_message, :api_gateway_managed) SENSITIVE = [] include Aws::Structure end |
#stage_variables ⇒ Hash<String,String>
A map that defines the stage variables for the stage.
Variable names can have alphanumeric and underscore characters.
Variable values can contain the following characters:
Uppercase and lowercase letters
Numbers
Special characters -._~:/?#&=,
1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 |
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1399 class AwsApiGatewayV2StageDetails < Struct.new( :client_certificate_id, :created_date, :description, :default_route_settings, :deployment_id, :last_updated_date, :route_settings, :stage_name, :stage_variables, :access_log_settings, :auto_deploy, :last_deployment_status_message, :api_gateway_managed) SENSITIVE = [] include Aws::Structure end |