software.amazon.awssdk.services.ssm.model

Class AssociationVersionInfo

java.lang.Object

software.amazon.awssdk.services.ssm.model.AssociationVersionInfo

All Implemented Interfaces:

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

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

Information about the association version.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AssociationVersionInfo.Builder

Method Summary

Modifier and Type	Method and Description
String	associationId() The ID created by the system when the association was created.
String	associationName() The name specified for the association version when the association version was created.
String	associationVersion() The association version.
static AssociationVersionInfo.Builder	builder()
AssociationComplianceSeverity	complianceSeverity() The severity level that is assigned to the association.
String	complianceSeverityAsString() The severity level that is assigned to the association.
Instant	createdDate() The date the association version was created.
String	documentVersion() The version of a Systems Manager document used when the association version was created.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	maxConcurrency() The maximum number of targets allowed to run the association at the same time.
String	maxErrors() The number of errors that are allowed before the system stops sending requests to run the association on additional targets.
String	name() The name specified when the association was created.
InstanceAssociationOutputLocation	outputLocation() The location in Amazon S3 specified for the association when the association version was created.
Map<String,List<String>>	parameters() Parameters specified when the association version was created.
String	scheduleExpression() The cron or rate schedule specified for the association when the association version was created.
List<SdkField<?>>	sdkFields()
static Class<? extends AssociationVersionInfo.Builder>	serializableBuilderClass()
List<Target>	targets() The targets specified for the association when the association version was created.
AssociationVersionInfo.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

associationId

public String associationId()

The ID created by the system when the association was created.

Returns:

The ID created by the system when the association was created.

associationVersion

public String associationVersion()

The association version.

Returns:

The association version.

createdDate

public Instant createdDate()

The date the association version was created.

Returns:

The date the association version was created.

name

public String name()

The name specified when the association was created.

Returns:

The name specified when the association was created.

documentVersion

public String documentVersion()

The version of a Systems Manager document used when the association version was created.

Returns:

The version of a Systems Manager document used when the association version was created.

parameters

public Map<String,List<String>> parameters()

Parameters specified when the association version was created.

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

Returns:

Parameters specified when the association version was created.

targets

public List<Target> targets()

The targets specified for the association when the association version was created.

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

Returns:

The targets specified for the association when the association version was created.

scheduleExpression

public String scheduleExpression()

The cron or rate schedule specified for the association when the association version was created.

Returns:

The cron or rate schedule specified for the association when the association version was created.

outputLocation

public InstanceAssociationOutputLocation outputLocation()

The location in Amazon S3 specified for the association when the association version was created.

Returns:

The location in Amazon S3 specified for the association when the association version was created.

associationName

public String associationName()

The name specified for the association version when the association version was created.

Returns:

The name specified for the association version when the association version was created.

maxErrors

public String maxErrors()

The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

Returns:

The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

maxConcurrency

public String maxConcurrency()

The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

If a new instance starts and attempts to execute an association while Systems Manager is executing MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.

Returns:

The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

If a new instance starts and attempts to execute an association while Systems Manager is executing MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.

complianceSeverity

public AssociationComplianceSeverity complianceSeverity()

The severity level that is assigned to the association.

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

Returns:

The severity level that is assigned to the association.

See Also:

AssociationComplianceSeverity

complianceSeverityAsString

public String complianceSeverityAsString()

The severity level that is assigned to the association.

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

Returns:

The severity level that is assigned to the association.

See Also:

AssociationComplianceSeverity

toBuilder

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

Returns:

a builder for type T

builder

public static AssociationVersionInfo.Builder builder()

serializableBuilderClass

public static Class<? extends AssociationVersionInfo.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.