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 Systems Manager 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) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTargets() Returns true if the Targets property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	instanceId() The ID of the instance.
Instant	lastExecutionDate() The date on which the association was last run.
String	name() The name of the Systems Manager 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() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

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

name

public String name()

The name of the Systems Manager document.

Returns:

The name of the Systems Manager document.

instanceId

public String instanceId()

The ID of the instance.

Returns:

The ID of the instance.

associationId

public 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 String associationVersion()

The association version.

Returns:

The association version.

documentVersion

public String documentVersion()

The version of the document used in the association.

Returns:

The version of the document used in the association.

hasTargets

public boolean hasTargets()

Returns true if the Targets property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

targets

public 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.

You can use hasTargets() to see if a value was sent in this field.

Returns:

The instances targeted by the request to create an association.

lastExecutionDate

public Instant lastExecutionDate()

The date on which the association was last run.

Returns:

The date on which the association was last run.

overview

public AssociationOverview overview()

Information about the association.

Returns:

Information about the association.

scheduleExpression

public String scheduleExpression()

A cron expression that specifies a schedule when the association runs.

Returns:

A cron expression that specifies a schedule when the association runs.

associationName

public String associationName()

The association name.

Returns:

The association name.

toBuilder

public Association.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<Association.Builder,Association>

Returns:

a builder for type T

builder

public static Association.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public 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 <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.