Class: Aws::SecurityHub::Types::AwsApiGatewayV2StageDetails

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 AwsApiGatewayV2StageDetails data as a hash:

{
  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

Instance Attribute Details

#access_log_settingsTypes::AwsApiGatewayAccessLogSettings

Information about settings for logging access for the stage.



1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1365

class AwsApiGatewayV2StageDetails < Struct.new(
  :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_managedBoolean

Indicates whether the stage is managed by API Gateway.

Returns:

  • (Boolean)


1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1365

class AwsApiGatewayV2StageDetails < Struct.new(
  :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_deployBoolean

Indicates whether updates to an API automatically trigger a new deployment.

Returns:

  • (Boolean)


1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1365

class AwsApiGatewayV2StageDetails < Struct.new(
  :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_dateString

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.

Returns:

  • (String)


1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1365

class AwsApiGatewayV2StageDetails < Struct.new(
  :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_settingsTypes::AwsApiGatewayV2RouteSettings

Default route settings for the stage.



1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1365

class AwsApiGatewayV2StageDetails < Struct.new(
  :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_idString

The identifier of the deployment that the stage is associated with.

Returns:

  • (String)


1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1365

class AwsApiGatewayV2StageDetails < Struct.new(
  :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

#descriptionString

The description of the stage.

Returns:

  • (String)


1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1365

class AwsApiGatewayV2StageDetails < Struct.new(
  :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_messageString

The status of the last deployment of a stage. Supported only if the stage has automatic deployment enabled.

Returns:

  • (String)


1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1365

class AwsApiGatewayV2StageDetails < Struct.new(
  :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_dateString

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.

Returns:

  • (String)


1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1365

class AwsApiGatewayV2StageDetails < Struct.new(
  :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_settingsTypes::AwsApiGatewayV2RouteSettings

The route settings for the stage.



1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1365

class AwsApiGatewayV2StageDetails < Struct.new(
  :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_nameString

The name of the stage.

Returns:

  • (String)


1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1365

class AwsApiGatewayV2StageDetails < Struct.new(
  :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_variablesHash<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 -._~:/?#&=,

Returns:

  • (Hash<String,String>)


1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1365

class AwsApiGatewayV2StageDetails < Struct.new(
  :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