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
Boolean	applyOnlyAtCronInterval() By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified.
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()
List<String>	calendarNames() The names or Amazon Resource Names (ARNs) of the Systems Manager Change Calendar type documents your associations are gated under.
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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCalendarNames() Returns true if the CalendarNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasParameters() Returns true if the Parameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasTargetLocations() Returns true if the TargetLocations property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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	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()
AssociationSyncCompliance	syncCompliance() The mode for generating association compliance.
String	syncComplianceAsString() The mode for generating association compliance.
List<TargetLocation>	targetLocations() The combination of AWS Regions and AWS accounts where you wanted to run the association when this association version was created.
List<Target>	targets() The targets specified for the association when the association version was created.
AssociationVersionInfo.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

associationId

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

The association version.

Returns:

The association version.

createdDate

public final Instant createdDate()

The date the association version was created.

Returns:

The date the association version was created.

name

public final String name()

The name specified when the association was created.

Returns:

The name specified when the association was created.

documentVersion

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

hasParameters

public final boolean hasParameters()

Returns true if the Parameters 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.

parameters

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

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

Returns:

Parameters specified when the association version was created.

hasTargets

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

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

Returns:

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

scheduleExpression

public final 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 final 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 final 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 final 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 final 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 run an association while Systems Manager is running 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 run an association while Systems Manager is running 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 final 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 final 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

syncCompliance

public final AssociationSyncCompliance syncCompliance()

The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.

By default, all associations use AUTO mode.

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

Returns:

The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.

By default, all associations use AUTO mode.

See Also:

AssociationSyncCompliance

syncComplianceAsString

public final String syncComplianceAsString()

The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.

By default, all associations use AUTO mode.

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

Returns:

The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.

By default, all associations use AUTO mode.

See Also:

AssociationSyncCompliance

applyOnlyAtCronInterval

public final Boolean applyOnlyAtCronInterval()

By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter is not supported for rate expressions.

Returns:

By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter is not supported for rate expressions.

hasCalendarNames

public final boolean hasCalendarNames()

Returns true if the CalendarNames 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.

calendarNames

public final List<String> calendarNames()

The names or Amazon Resource Names (ARNs) of the Systems Manager Change Calendar type documents your associations are gated under. The associations for this version only run when that Change Calendar is open. For more information, see AWS Systems Manager Change Calendar.

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

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

Returns:

The names or Amazon Resource Names (ARNs) of the Systems Manager Change Calendar type documents your associations are gated under. The associations for this version only run when that Change Calendar is open. For more information, see AWS Systems Manager Change Calendar.

hasTargetLocations

public final boolean hasTargetLocations()

Returns true if the TargetLocations 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.

targetLocations

public final List<TargetLocation> targetLocations()

The combination of AWS Regions and AWS accounts where you wanted to run the association when this association version was created.

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

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

Returns:

The combination of AWS Regions and AWS accounts where you wanted to run the association when this association version was created.

toBuilder

public AssociationVersionInfo.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AssociationVersionInfo.Builder,AssociationVersionInfo>

builder

public static AssociationVersionInfo.Builder builder()

serializableBuilderClass

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