Class: Aws::ConfigService::Types::Evaluation

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

Overview

Note:

When making an API call, you may pass Evaluation data as a hash:

{
  compliance_resource_type: "StringWithCharLimit256", # required
  compliance_resource_id: "BaseResourceId", # required
  compliance_type: "COMPLIANT", # required, accepts COMPLIANT, NON_COMPLIANT, NOT_APPLICABLE, INSUFFICIENT_DATA
  annotation: "StringWithCharLimit256",
  ordering_timestamp: Time.now, # required
}

Identifies an Amazon Web Services resource and indicates whether it complies with the Config rule that it was evaluated against.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#annotation ⇒ String

Supplementary information about how the evaluation determined the compliance.

Returns:

  • (String) 


3839
3840
3841
3842
3843
3844
3845
3846
3847
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 3839

class Evaluation < Struct.new(
  :compliance_resource_type,
  :compliance_resource_id,
  :compliance_type,
  :annotation,
  :ordering_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#compliance_resource_id ⇒ String

The ID of the Amazon Web Services resource that was evaluated.

Returns:

  • (String) 


3839
3840
3841
3842
3843
3844
3845
3846
3847
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 3839

class Evaluation < Struct.new(
  :compliance_resource_type,
  :compliance_resource_id,
  :compliance_type,
  :annotation,
  :ordering_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#compliance_resource_type ⇒ String

The type of Amazon Web Services resource that was evaluated.

Returns:

  • (String) 


3839
3840
3841
3842
3843
3844
3845
3846
3847
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 3839

class Evaluation < Struct.new(
  :compliance_resource_type,
  :compliance_resource_id,
  :compliance_type,
  :annotation,
  :ordering_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#compliance_type ⇒ String

Indicates whether the Amazon Web Services resource complies with the Config rule that it was evaluated against.

For the Evaluation data type, Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. Config does not support the INSUFFICIENT_DATA value for this data type.

Similarly, Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an Lambda function for a custom Config rule cannot pass an INSUFFICIENT_DATA value to Config.

Returns:

  • (String) 


3839
3840
3841
3842
3843
3844
3845
3846
3847
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 3839

class Evaluation < Struct.new(
  :compliance_resource_type,
  :compliance_resource_id,
  :compliance_type,
  :annotation,
  :ordering_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#ordering_timestamp ⇒ Time

The time of the event in Config that triggered the evaluation. For event-based evaluations, the time indicates when Config created the configuration item that triggered the evaluation. For periodic evaluations, the time indicates when Config triggered the evaluation at the frequency that you specified (for example, every 24 hours).

Returns:

  • (Time) 


3839
3840
3841
3842
3843
3844
3845
3846
3847
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 3839

class Evaluation < Struct.new(
  :compliance_resource_type,
  :compliance_resource_id,
  :compliance_type,
  :annotation,
  :ordering_timestamp)
  SENSITIVE = []
  include Aws::Structure
end