software.amazon.awssdk.services.ssm.model

Class ComplianceItem

java.lang.Object

software.amazon.awssdk.services.ssm.model.ComplianceItem

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ComplianceItem.Builder,ComplianceItem>

@Generated(value="software.amazon.awssdk:codegen")
public final class ComplianceItem
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ComplianceItem.Builder,ComplianceItem>

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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ComplianceItem.Builder

Method Summary

Modifier and Type	Method and Description
static ComplianceItem.Builder	builder()
String	complianceType() The compliance type.
Map<String,String>	details() A "Key": "Value" tag combination for the compliance item.
boolean	equals(Object obj)
ComplianceExecutionSummary	executionSummary() A summary for the compliance item.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id() An ID for the compliance item.
String	resourceId() An ID for the resource.
String	resourceType() The type of resource.
List<SdkField<?>>	sdkFields()
static Class<? extends ComplianceItem.Builder>	serializableBuilderClass()
ComplianceSeverity	severity() The severity of the compliance status.
String	severityAsString() The severity of the compliance status.
ComplianceStatus	status() The status of the compliance item.
String	statusAsString() The status of the compliance item.
String	title() A title for the compliance item.
ComplianceItem.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

complianceType

public String complianceType()

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

Returns:

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

resourceType

public String resourceType()

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

Returns:

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

resourceId

public String resourceId()

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

Returns:

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

id

public String id()

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; for example: KB4010320.

Returns:

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; for example: KB4010320.

title

public String title()

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; for example: Security Update for Active Directory Federation Services.

Returns:

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; for example: Security Update for Active Directory Federation Services.

status

public ComplianceStatus status()

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

If the service returns an enum value that is not available in the current SDK version, status will return ComplianceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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

See Also:

ComplianceStatus

statusAsString

public String statusAsString()

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

If the service returns an enum value that is not available in the current SDK version, status will return ComplianceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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

See Also:

ComplianceStatus

severity

public ComplianceSeverity severity()

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

If the service returns an enum value that is not available in the current SDK version, severity will return ComplianceSeverity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from severityAsString().

Returns:

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

See Also:

ComplianceSeverity

severityAsString

public String severityAsString()

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

If the service returns an enum value that is not available in the current SDK version, severity will return ComplianceSeverity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from severityAsString().

Returns:

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

See Also:

ComplianceSeverity

executionSummary

public ComplianceExecutionSummary executionSummary()

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

Returns:

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

details

public Map<String,String> details()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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

toBuilder

public ComplianceItem.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ComplianceItem.Builder,ComplianceItem>

Returns:

a builder for type T

builder

public static ComplianceItem.Builder builder()

serializableBuilderClass

public static Class<? extends ComplianceItem.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.