software.amazon.awssdk.services.ssm.model

Interface UpdateAssociationRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateAssociationRequest.Builder,UpdateAssociationRequest>, SdkBuilder<UpdateAssociationRequest.Builder,UpdateAssociationRequest>, SdkPojo, SdkRequest.Builder, SsmRequest.Builder

Enclosing class:

UpdateAssociationRequest

public static interface UpdateAssociationRequest.Builder
extends SsmRequest.Builder, SdkPojo, CopyableBuilder<UpdateAssociationRequest.Builder,UpdateAssociationRequest>

Method Summary

Modifier and Type	Method and Description
UpdateAssociationRequest.Builder	applyOnlyAtCronInterval(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.
UpdateAssociationRequest.Builder	associationId(String associationId) The ID of the association you want to update.
UpdateAssociationRequest.Builder	associationName(String associationName) The name of the association that you want to update.
UpdateAssociationRequest.Builder	associationVersion(String associationVersion) This parameter is provided for concurrency control purposes.
UpdateAssociationRequest.Builder	automationTargetParameterName(String automationTargetParameterName) Specify the target for the association.
UpdateAssociationRequest.Builder	complianceSeverity(AssociationComplianceSeverity complianceSeverity) The severity level to assign to the association.
UpdateAssociationRequest.Builder	complianceSeverity(String complianceSeverity) The severity level to assign to the association.
UpdateAssociationRequest.Builder	documentVersion(String documentVersion) The document version you want update for the association.
UpdateAssociationRequest.Builder	maxConcurrency(String maxConcurrency) The maximum number of targets allowed to run the association at the same time.
UpdateAssociationRequest.Builder	maxErrors(String maxErrors) The number of errors that are allowed before the system stops sending requests to run the association on additional targets.
UpdateAssociationRequest.Builder	name(String name) The name of the SSM document that contains the configuration information for the instance.
default UpdateAssociationRequest.Builder	outputLocation(Consumer<InstanceAssociationOutputLocation.Builder> outputLocation) An S3 bucket where you want to store the results of this request.
UpdateAssociationRequest.Builder	outputLocation(InstanceAssociationOutputLocation outputLocation) An S3 bucket where you want to store the results of this request.
UpdateAssociationRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
UpdateAssociationRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
UpdateAssociationRequest.Builder	parameters(Map<String,? extends Collection<String>> parameters) The parameters you want to update for the association.
UpdateAssociationRequest.Builder	scheduleExpression(String scheduleExpression) The cron expression used to schedule the association that you want to update.
UpdateAssociationRequest.Builder	syncCompliance(AssociationSyncCompliance syncCompliance) The mode for generating association compliance.
UpdateAssociationRequest.Builder	syncCompliance(String syncCompliance) The mode for generating association compliance.
UpdateAssociationRequest.Builder	targets(Collection<Target> targets) The targets of the association.
UpdateAssociationRequest.Builder	targets(Consumer<Target.Builder>... targets) The targets of the association.
UpdateAssociationRequest.Builder	targets(Target... targets) The targets of the association.

Methods inherited from interface software.amazon.awssdk.services.ssm.model.SsmRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

associationId

UpdateAssociationRequest.Builder associationId(String associationId)

The ID of the association you want to update.

Parameters:

associationId - The ID of the association you want to update.

Returns:

Returns a reference to this object so that method calls can be chained together.

parameters

UpdateAssociationRequest.Builder parameters(Map<String,? extends Collection<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}}

Parameters:

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}}

Returns:

Returns a reference to this object so that method calls can be chained together.

documentVersion

UpdateAssociationRequest.Builder documentVersion(String documentVersion)

The document version you want update for the association.

Parameters:

documentVersion - The document version you want update for the association.

Returns:

Returns a reference to this object so that method calls can be chained together.

scheduleExpression

UpdateAssociationRequest.Builder scheduleExpression(String scheduleExpression)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

outputLocation

UpdateAssociationRequest.Builder outputLocation(InstanceAssociationOutputLocation outputLocation)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

outputLocation

default UpdateAssociationRequest.Builder outputLocation(Consumer<InstanceAssociationOutputLocation.Builder> outputLocation)

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

This is a convenience that creates an instance of the InstanceAssociationOutputLocation.Builder avoiding the need to create one manually via InstanceAssociationOutputLocation.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outputLocation(InstanceAssociationOutputLocation).

Parameters:

outputLocation - a consumer that will call methods on InstanceAssociationOutputLocation.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

outputLocation(InstanceAssociationOutputLocation)

name

UpdateAssociationRequest.Builder name(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

targets

UpdateAssociationRequest.Builder targets(Collection<Target> targets)

The targets of the association.

Parameters:

targets - The targets of the association.

Returns:

Returns a reference to this object so that method calls can be chained together.

targets

UpdateAssociationRequest.Builder targets(Target... targets)

The targets of the association.

Parameters:

targets - The targets of the association.

Returns:

Returns a reference to this object so that method calls can be chained together.

targets

UpdateAssociationRequest.Builder targets(Consumer<Target.Builder>... targets)

The targets of the association.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #targets(List).

Parameters:

targets - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#targets(List)

associationName

UpdateAssociationRequest.Builder associationName(String associationName)

The name of the association that you want to update.

Parameters:

associationName - The name of the association that you want to update.

Returns:

Returns a reference to this object so that method calls can be chained together.

associationVersion

UpdateAssociationRequest.Builder associationVersion(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

automationTargetParameterName

UpdateAssociationRequest.Builder automationTargetParameterName(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

maxErrors

UpdateAssociationRequest.Builder maxErrors(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

maxConcurrency

UpdateAssociationRequest.Builder maxConcurrency(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

complianceSeverity

UpdateAssociationRequest.Builder complianceSeverity(String complianceSeverity)

The severity level to assign to the association.

Parameters:

complianceSeverity - The severity level to assign to the association.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AssociationComplianceSeverity, AssociationComplianceSeverity

complianceSeverity

UpdateAssociationRequest.Builder complianceSeverity(AssociationComplianceSeverity complianceSeverity)

The severity level to assign to the association.

Parameters:

complianceSeverity - The severity level to assign to the association.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AssociationComplianceSeverity, AssociationComplianceSeverity

syncCompliance

UpdateAssociationRequest.Builder syncCompliance(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AssociationSyncCompliance, AssociationSyncCompliance

syncCompliance

UpdateAssociationRequest.Builder syncCompliance(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AssociationSyncCompliance, AssociationSyncCompliance

applyOnlyAtCronInterval

UpdateAssociationRequest.Builder applyOnlyAtCronInterval(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

UpdateAssociationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

UpdateAssociationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.