software.amazon.awssdk.services.ssm.model

Class Association

java.lang.Object

software.amazon.awssdk.services.ssm.model.Association

All Implemented Interfaces:

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

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

Describes an association of a Amazon Web Services Systems Manager document (SSM document) and an instance.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Association.Builder

Method Summary

Modifier and Type	Method and Description
String	associationId() The ID created by the system when you create an association.
String	associationName() The association name.
String	associationVersion() The association version.
static Association.Builder	builder()
String	documentVersion() The version of the document used in the association.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTargets() For responses, this returns true if the service returned a value for the Targets property.
String	instanceId() The instance ID.
Instant	lastExecutionDate() The date on which the association was last run.
String	name() The name of the SSM document.
AssociationOverview	overview() Information about the association.
String	scheduleExpression() A cron expression that specifies a schedule when the association runs.
List<SdkField<?>>	sdkFields()
static Class<? extends Association.Builder>	serializableBuilderClass()
List<Target>	targets() The instances targeted by the request to create an association.
Association.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

name

public final String name()

The name of the SSM document.

Returns:

The name of the SSM document.

instanceId

public final String instanceId()

The instance ID.

Returns:

The instance ID.

associationId

public final String associationId()

The ID created by the system when you create an association. An association is a binding between a document and a set of targets with a schedule.

Returns:

The ID created by the system when you create an association. An association is a binding between a document and a set of targets with a schedule.

associationVersion

public final String associationVersion()

The association version.

Returns:

The association version.

documentVersion

public final String documentVersion()

The version of the document used in the association.

Returns:

The version of the document used in the association.

hasTargets

public final boolean hasTargets()

For responses, this returns true if the service returned a value for the Targets property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

targets

public final List<Target> targets()

The instances targeted by the request to create an association.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTargets() method.

Returns:

The instances targeted by the request to create an association.

lastExecutionDate

public final Instant lastExecutionDate()

The date on which the association was last run.

Returns:

The date on which the association was last run.

overview

public final AssociationOverview overview()

Information about the association.

Returns:

Information about the association.

scheduleExpression

public final String scheduleExpression()

A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated Universal Time (UTC).

Returns:

A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated Universal Time (UTC).

associationName

public final String associationName()

The association name.

Returns:

The association name.

toBuilder

public Association.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Association.Builder,Association>

builder

public static Association.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo