Class: Aws::SecurityHub::Types::SecurityControlDefinition

Inherits:

Struct

• Object
• Struct
• Aws::SecurityHub::Types::SecurityControlDefinition

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-securityhub/types.rb

Overview

Provides metadata for a security control, including its unique standard-agnostic identifier, title, description, severity, availability in Amazon Web Services Regions, and a link to remediation steps.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #current_region_availability ⇒ String

  Specifies whether a security control is available in the current Amazon Web Services Region.

• #customizable_properties ⇒ Array<String>

  Security control properties that you can customize.

• #description ⇒ String

  The description of a security control across standards.

• #parameter_definitions ⇒ Hash<String,Types::ParameterDefinition>

  An object that provides a security control parameter name, description, and the options for customizing it.

• #remediation_url ⇒ String

  A link to Security Hub documentation that explains how to remediate a failed finding for a security control.

• #security_control_id ⇒ String

  The unique identifier of a security control across standards.

• #severity_rating ⇒ String

  The severity of a security control.

• #title ⇒ String

  The title of a security control.

Instance Attribute Details

#current_region_availability ⇒ String

Specifies whether a security control is available in the current Amazon Web Services Region.

Returns:

• (String)

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

class SecurityControlDefinition < Struct.new(
  :security_control_id,
  :title,
  :description,
  :remediation_url,
  :severity_rating,
  :current_region_availability,
  :customizable_properties,
  :parameter_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#customizable_properties ⇒ Array<String>

Security control properties that you can customize. Currently, only parameter customization is supported for select controls. An empty array is returned for controls that don’t support custom properties.

Returns:

• (Array<String>)

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

class SecurityControlDefinition < Struct.new(
  :security_control_id,
  :title,
  :description,
  :remediation_url,
  :severity_rating,
  :current_region_availability,
  :customizable_properties,
  :parameter_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of a security control across standards. This typically summarizes how Security Hub evaluates the control and the conditions under which it produces a failed finding. This parameter doesn’t reference a specific standard.

Returns:

• (String)

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

class SecurityControlDefinition < Struct.new(
  :security_control_id,
  :title,
  :description,
  :remediation_url,
  :severity_rating,
  :current_region_availability,
  :customizable_properties,
  :parameter_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#parameter_definitions ⇒ Hash<String,Types::ParameterDefinition>

An object that provides a security control parameter name, description, and the options for customizing it. This object is excluded for a control that doesn’t support custom parameters.

Returns:

• (Hash<String,Types::ParameterDefinition>)

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

class SecurityControlDefinition < Struct.new(
  :security_control_id,
  :title,
  :description,
  :remediation_url,
  :severity_rating,
  :current_region_availability,
  :customizable_properties,
  :parameter_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#remediation_url ⇒ String

A link to Security Hub documentation that explains how to remediate a failed finding for a security control.

Returns:

• (String)

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

class SecurityControlDefinition < Struct.new(
  :security_control_id,
  :title,
  :description,
  :remediation_url,
  :severity_rating,
  :current_region_availability,
  :customizable_properties,
  :parameter_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#security_control_id ⇒ String

The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Services service name and a number (for example, APIGateway.3). This parameter differs from ‘SecurityControlArn`, which is a unique Amazon Resource Name (ARN) assigned to a control. The ARN references the security control ID (for example, arn:aws:securityhub:eu-central-1:123456789012:security-control/APIGateway.3).

Returns:

• (String)

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

class SecurityControlDefinition < Struct.new(
  :security_control_id,
  :title,
  :description,
  :remediation_url,
  :severity_rating,
  :current_region_availability,
  :customizable_properties,
  :parameter_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#severity_rating ⇒ String

The severity of a security control. For more information about how Security Hub determines control severity, see [Assigning severity to control findings] in the *Security Hub User Guide*.

[1]: docs.aws.amazon.com/securityhub/latest/userguide/controls-findings-create-update.html#control-findings-severity

Returns:

• (String)

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

class SecurityControlDefinition < Struct.new(
  :security_control_id,
  :title,
  :description,
  :remediation_url,
  :severity_rating,
  :current_region_availability,
  :customizable_properties,
  :parameter_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#title ⇒ String

The title of a security control.

Returns:

• (String)

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

class SecurityControlDefinition < Struct.new(
  :security_control_id,
  :title,
  :description,
  :remediation_url,
  :severity_rating,
  :current_region_availability,
  :customizable_properties,
  :parameter_definitions)
  SENSITIVE = []
  include Aws::Structure
end