You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SSM::Types::ComplianceItem

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

Overview

Information about the compliance as defined by the resource type. For example, for a patch resource type, Items includes information about the PatchSeverity, Classification, etc.

Instance Attribute Summary collapse

Instance Attribute Details

#compliance_typeString

The compliance type. For example, Association (for a State Manager association), Patch, or Custom:string are all valid compliance types.

Returns:

  • (String)


1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1198

class ComplianceItem < Struct.new(
  :compliance_type,
  :resource_type,
  :resource_id,
  :id,
  :title,
  :status,
  :severity,
  :execution_summary,
  :details)
  include Aws::Structure
end

#detailsHash<String,String>

A "Key": "Value" tag combination for the compliance item.

Returns:

  • (Hash<String,String>)


1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1198

class ComplianceItem < Struct.new(
  :compliance_type,
  :resource_type,
  :resource_id,
  :id,
  :title,
  :status,
  :severity,
  :execution_summary,
  :details)
  include Aws::Structure
end

#execution_summaryTypes::ComplianceExecutionSummary

A summary for the compliance item. The summary includes an execution ID, the execution type (for example, command), and the execution time.



1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1198

class ComplianceItem < Struct.new(
  :compliance_type,
  :resource_type,
  :resource_id,
  :id,
  :title,
  :status,
  :severity,
  :execution_summary,
  :details)
  include Aws::Structure
end

#idString

An ID for the compliance item. For example, if the compliance item is a Windows patch, the ID could be the number of the KB article. Here's an example: KB4010320.

Returns:

  • (String)


1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1198

class ComplianceItem < Struct.new(
  :compliance_type,
  :resource_type,
  :resource_id,
  :id,
  :title,
  :status,
  :severity,
  :execution_summary,
  :details)
  include Aws::Structure
end

#resource_idString

An ID for the resource. For a managed instance, this is the instance ID.

Returns:

  • (String)


1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1198

class ComplianceItem < Struct.new(
  :compliance_type,
  :resource_type,
  :resource_id,
  :id,
  :title,
  :status,
  :severity,
  :execution_summary,
  :details)
  include Aws::Structure
end

#resource_typeString

The type of resource. ManagedInstance is currently the only supported resource type.

Returns:

  • (String)


1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1198

class ComplianceItem < Struct.new(
  :compliance_type,
  :resource_type,
  :resource_id,
  :id,
  :title,
  :status,
  :severity,
  :execution_summary,
  :details)
  include Aws::Structure
end

#severityString

The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.

Returns:

  • (String)


1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1198

class ComplianceItem < Struct.new(
  :compliance_type,
  :resource_type,
  :resource_id,
  :id,
  :title,
  :status,
  :severity,
  :execution_summary,
  :details)
  include Aws::Structure
end

#statusString

The status of the compliance item. An item is either COMPLIANT or NON_COMPLIANT.

Returns:

  • (String)


1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1198

class ComplianceItem < Struct.new(
  :compliance_type,
  :resource_type,
  :resource_id,
  :id,
  :title,
  :status,
  :severity,
  :execution_summary,
  :details)
  include Aws::Structure
end

#titleString

A title for the compliance item. For example, if the compliance item is a Windows patch, the title could be the title of the KB article for the patch. Here's an example: Security Update for Active Directory Federation Services.

Returns:

  • (String)


1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1198

class ComplianceItem < Struct.new(
  :compliance_type,
  :resource_type,
  :resource_id,
  :id,
  :title,
  :status,
  :severity,
  :execution_summary,
  :details)
  include Aws::Structure
end