Class: Aws::SecurityHub::Types::Compliance

Inherits:

Struct

• Object
• Struct
• Aws::SecurityHub::Types::Compliance

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-securityhub/types.rb

Overview

This object typically provides details about a control finding, such as applicable standards and the status of control checks. While finding providers can add custom content in ‘Compliance` object fields, they are typically used to review details of Security Hub control findings.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #associated_standards ⇒ Array<Types::AssociatedStandard>

  Typically provides an array of enabled security standards in which a security control is currently enabled.

• #related_requirements ⇒ Array<String>

  Typically provides the industry or regulatory framework requirements that are related to a control.

• #security_control_id ⇒ String

  Typically provides the unique identifier of a control across standards.

• #security_control_parameters ⇒ Array<Types::SecurityControlParameter>

  Typically an object that includes security control parameter names and values.

• #status ⇒ String

  Typically summarizes the result of a control check.

• #status_reasons ⇒ Array<Types::StatusReason>

  Typically used to provide a list of reasons for the value of ‘Status`.

Instance Attribute Details

#associated_standards ⇒ Array<Types::AssociatedStandard>

Typically provides an array of enabled security standards in which a security control is currently enabled.

Returns:

• (Array<Types::AssociatedStandard>)

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

class Compliance < Struct.new(
  :status,
  :related_requirements,
  :status_reasons,
  :security_control_id,
  :associated_standards,
  :security_control_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#related_requirements ⇒ Array<String>

Typically provides the industry or regulatory framework requirements that are related to a control. The check for that control is aligned with these requirements.

Array Members: Maximum number of 32 items.

Returns:

• (Array<String>)

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

class Compliance < Struct.new(
  :status,
  :related_requirements,
  :status_reasons,
  :security_control_id,
  :associated_standards,
  :security_control_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#security_control_id ⇒ String

Typically provides the unique identifier of a control across standards. For Security Hub controls, this field consists of an Amazon Web Services service and a unique number, such as ‘APIGateway.5`.

Returns:

• (String)

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

class Compliance < Struct.new(
  :status,
  :related_requirements,
  :status_reasons,
  :security_control_id,
  :associated_standards,
  :security_control_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#security_control_parameters ⇒ Array<Types::SecurityControlParameter>

Typically an object that includes security control parameter names and values.

Returns:

• (Array<Types::SecurityControlParameter>)

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

class Compliance < Struct.new(
  :status,
  :related_requirements,
  :status_reasons,
  :security_control_id,
  :associated_standards,
  :security_control_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

Typically summarizes the result of a control check.

For Security Hub controls, valid values for ‘Status` are as follows.

• • ‘PASSED` - Standards check passed for all evaluated resources.

  • ‘WARNING` - Some information is missing or this check is not supported for your configuration.

  • ‘FAILED` - Standards check failed for at least one evaluated resource.

  • ‘NOT_AVAILABLE` - Check could not be performed due to a service outage, API error, or because the result of the Config evaluation was `NOT_APPLICABLE`. If the Config evaluation result was `NOT_APPLICABLE` for a Security Hub control, Security Hub automatically archives the finding after 3 days.

Returns:

• (String)

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

class Compliance < Struct.new(
  :status,
  :related_requirements,
  :status_reasons,
  :security_control_id,
  :associated_standards,
  :security_control_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#status_reasons ⇒ Array<Types::StatusReason>

Typically used to provide a list of reasons for the value of ‘Status`.

Returns:

• (Array<Types::StatusReason>)

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

class Compliance < Struct.new(
  :status,
  :related_requirements,
  :status_reasons,
  :security_control_id,
  :associated_standards,
  :security_control_parameters)
  SENSITIVE = []
  include Aws::Structure
end