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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-securityhub/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 CSPM control findings.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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:



22721
22722
22723
22724
22725
22726
22727
22728
22729
22730
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 22721

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


22721
22722
22723
22724
22725
22726
22727
22728
22729
22730
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 22721

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 CSPM controls, this field consists of an Amazon Web Services service and a unique number, such as APIGateway.5.

Returns:

  • (String) 


22721
22722
22723
22724
22725
22726
22727
22728
22729
22730
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 22721

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:



22721
22722
22723
22724
22725
22726
22727
22728
22729
22730
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 22721

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 CSPM 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 CSPM control, Security Hub CSPM automatically archives the finding after 3 days.

Returns:

  • (String) 


22721
22722
22723
22724
22725
22726
22727
22728
22729
22730
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 22721

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:



22721
22722
22723
22724
22725
22726
22727
22728
22729
22730
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 22721

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