software.amazon.awssdk.services.ssm.model

Class UpdateAssociationRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ssm.model.SsmRequest

software.amazon.awssdk.services.ssm.model.UpdateAssociationRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateAssociationRequest.Builder,UpdateAssociationRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateAssociationRequest
extends SsmRequest
implements ToCopyableBuilder<UpdateAssociationRequest.Builder,UpdateAssociationRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateAssociationRequest.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	applyOnlyAtCronInterval() By default, when you update an association, the system runs it immediately after it is updated and then according to the schedule you specified.
String	associationId() The ID of the association you want to update.
String	associationName() The name of the association that you want to update.
String	associationVersion() This parameter is provided for concurrency control purposes.
String	automationTargetParameterName() Specify the target for the association.
static UpdateAssociationRequest.Builder	builder()
AssociationComplianceSeverity	complianceSeverity() The severity level to assign to the association.
String	complianceSeverityAsString() The severity level to assign to the association.
String	documentVersion() The document version you want update for 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) Used to retrieve the value of a field from any class that extends SdkRequest.
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	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 of the SSM document that contains the configuration information for the instance.
InstanceAssociationOutputLocation	outputLocation() An S3 bucket where you want to store the results of this request.
Map<String,List<String>>	parameters() The parameters you want to update for the association.
String	scheduleExpression() The cron expression used to schedule the association that you want to update.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateAssociationRequest.Builder>	serializableBuilderClass()
AssociationSyncCompliance	syncCompliance() The mode for generating association compliance.
String	syncComplianceAsString() The mode for generating association compliance.
List<Target>	targets() The targets of the association.
UpdateAssociationRequest.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 software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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 of the association you want to update.

Returns:

The ID of the association you want to update.

hasParameters

public 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 Map<String,List<String>> parameters()

The parameters you want to update for the association. If you create a parameter using Parameter Store, you can reference the parameter using {{ssm:parameter-name}}

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:

The parameters you want to update for the association. If you create a parameter using Parameter Store, you can reference the parameter using {{ssm:parameter-name}}

documentVersion

public String documentVersion()

The document version you want update for the association.

Returns:

The document version you want update for the association.

scheduleExpression

public String scheduleExpression()

The cron expression used to schedule the association that you want to update.

Returns:

The cron expression used to schedule the association that you want to update.

outputLocation

public InstanceAssociationOutputLocation outputLocation()

An S3 bucket where you want to store the results of this request.

Returns:

An S3 bucket where you want to store the results of this request.

name

public String name()

The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.

You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account.

For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format:

arn:aws:ssm:region:account-id:document/document-name

For example:

arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document

For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.

Returns:

The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.

You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account.

For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format:

arn:aws:ssm:region:account-id:document/document-name

For example:

arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document

For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.

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 targets of the 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 targets of the association.

associationName

public String associationName()

The name of the association that you want to update.

Returns:

The name of the association that you want to update.

associationVersion

public String associationVersion()

This parameter is provided for concurrency control purposes. You must specify the latest association version in the service. If you want to ensure that this request succeeds, either specify $LATEST, or omit this parameter.

Returns:

This parameter is provided for concurrency control purposes. You must specify the latest association version in the service. If you want to ensure that this request succeeds, either specify $LATEST, or omit this parameter.

automationTargetParameterName

public String automationTargetParameterName()

Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.

Returns:

Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.

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 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 AssociationComplianceSeverity complianceSeverity()

The severity level to assign 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 to assign to the association.

See Also:

AssociationComplianceSeverity

complianceSeverityAsString

public String complianceSeverityAsString()

The severity level to assign 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 to assign to the association.

See Also:

AssociationComplianceSeverity

syncCompliance

public 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 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 Boolean applyOnlyAtCronInterval()

By default, when you update an association, the system runs it immediately after it is updated and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you update it.

Also, if you specified this option when you created the association, you can reset it. To do so, specify the no-apply-only-at-cron-interval parameter when you update the association from the command line. This parameter forces the association to run immediately after updating it and according to the interval specified.

Returns:

By default, when you update an association, the system runs it immediately after it is updated and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you update it.

Also, if you specified this option when you created the association, you can reset it. To do so, specify the no-apply-only-at-cron-interval parameter when you update the association from the command line. This parameter forces the association to run immediately after updating it and according to the interval specified.

toBuilder

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

Specified by:

toBuilder in class SsmRequest

Returns:

a builder for type T

builder

public static UpdateAssociationRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

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.