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

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

Overview

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.



975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 975

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_managedBoolean

Indicates whether the stage is managed by API Gateway.

Returns:

  • (Boolean)


975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 975

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_deployBoolean

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

Returns:

  • (Boolean)


975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 975

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_idString

The identifier of a client certificate for a stage. Supported only for WebSocket API calls.

Returns:

  • (String)


975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 975

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


975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 975

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_settingsTypes::AwsApiGatewayV2RouteSettings

Default route settings for the stage.



975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 975

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_idString

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

Returns:

  • (String)


975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 975

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

#descriptionString

The description of the stage.

Returns:

  • (String)


975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 975

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_messageString

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

Returns:

  • (String)


975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 975

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


975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 975

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_settingsTypes::AwsApiGatewayV2RouteSettings

The route settings for the stage.



975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 975

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_nameString

The name of the stage.

Returns:

  • (String)


975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 975

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


975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 975

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