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

Inherits:

Struct

Object
Struct
Aws::SecurityHub::Types::AwsApiGatewayV2StageDetails

show all

Includes:: Aws::Structure

Defined in:: 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

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

Returns:

(Types::AwsApiGatewayAccessLogSettings)

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

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.

Returns:

(Boolean)

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

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.

Returns:

(Boolean)

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

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.

Returns:

(String)

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

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.

For more information about the validation and formatting of timestamp fields in Security Hub, see [Timestamps].

[1]: docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps

Returns:

(String)

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

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.

Returns:

(Types::AwsApiGatewayV2RouteSettings)

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

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.

Returns:

(String)

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

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.

Returns:

(String)

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

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.

Returns:

(String)

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

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.

For more information about the validation and formatting of timestamp fields in Security Hub, see [Timestamps].

[1]: docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps

Returns:

(String)

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

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.

Returns:

(Types::AwsApiGatewayV2RouteSettings)

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

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.

Returns:

(String)

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

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 -._~:/?#&=,

Returns:

(Hash<String,String>)

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

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

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#access_log_settings ⇒ Types::AwsApiGatewayAccessLogSettings

#api_gateway_managed ⇒ Boolean

#auto_deploy ⇒ Boolean

#client_certificate_id ⇒ String

#created_date ⇒ String

#default_route_settings ⇒ Types::AwsApiGatewayV2RouteSettings

#deployment_id ⇒ String

#description ⇒ String

#last_deployment_status_message ⇒ String

#last_updated_date ⇒ String

#route_settings ⇒ Types::AwsApiGatewayV2RouteSettings

#stage_name ⇒ String

#stage_variables ⇒ Hash<String,String>

#access_log_settings ⇒ `Types::AwsApiGatewayAccessLogSettings`

#api_gateway_managed ⇒ `Boolean`

#auto_deploy ⇒ `Boolean`

#client_certificate_id ⇒ `String`

#created_date ⇒ `String`

#default_route_settings ⇒ `Types::AwsApiGatewayV2RouteSettings`

#deployment_id ⇒ `String`

#description ⇒ `String`

#last_deployment_status_message ⇒ `String`

#last_updated_date ⇒ `String`

#route_settings ⇒ `Types::AwsApiGatewayV2RouteSettings`

#stage_name ⇒ `String`

#stage_variables ⇒ `Hash<String,String>`