software.amazon.awssdk.services.ssm.model

Interface CreateAssociationRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateAssociationRequest

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

Method Summary

Modifier and Type	Method and Description
CreateAssociationRequest.Builder	associationName(String associationName) Specify a descriptive name for the association.
CreateAssociationRequest.Builder	complianceSeverity(AssociationComplianceSeverity complianceSeverity) The severity level to assign to the association.
CreateAssociationRequest.Builder	complianceSeverity(String complianceSeverity) The severity level to assign to the association.
CreateAssociationRequest.Builder	documentVersion(String documentVersion) The document version you want to associate with the target(s).
CreateAssociationRequest.Builder	instanceId(String instanceId) The instance ID.
CreateAssociationRequest.Builder	maxConcurrency(String maxConcurrency) The maximum number of targets allowed to run the association at the same time.
CreateAssociationRequest.Builder	maxErrors(String maxErrors) The number of errors that are allowed before the system stops sending requests to run the association on additional targets.
CreateAssociationRequest.Builder	name(String name) The name of the Systems Manager document.
default CreateAssociationRequest.Builder	outputLocation(Consumer<InstanceAssociationOutputLocation.Builder> outputLocation) An Amazon S3 bucket where you want to store the output details of the request.
CreateAssociationRequest.Builder	outputLocation(InstanceAssociationOutputLocation outputLocation) An Amazon S3 bucket where you want to store the output details of the request.
CreateAssociationRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateAssociationRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateAssociationRequest.Builder	parameters(Map<String,? extends Collection<String>> parameters) The parameters for the documents runtime configuration.
CreateAssociationRequest.Builder	scheduleExpression(String scheduleExpression) A cron expression when the association will be applied to the target(s).
CreateAssociationRequest.Builder	targets(Collection<Target> targets) The targets (either instances or tags) for the association.
CreateAssociationRequest.Builder	targets(Consumer<Target.Builder>... targets) The targets (either instances or tags) for the association.
CreateAssociationRequest.Builder	targets(Target... targets) The targets (either instances or tags) for 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

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

name

CreateAssociationRequest.Builder name(String name)

The name of the Systems Manager document.

Parameters:

name - The name of the Systems Manager document.

Returns:

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

documentVersion

CreateAssociationRequest.Builder documentVersion(String documentVersion)

The document version you want to associate with the target(s). Can be a specific version or the default version.

Parameters:

documentVersion - The document version you want to associate with the target(s). Can be a specific version or the default version.

Returns:

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

instanceId

CreateAssociationRequest.Builder instanceId(String instanceId)

The instance ID.

Parameters:

instanceId - The instance ID.

Returns:

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

parameters

CreateAssociationRequest.Builder parameters(Map<String,? extends Collection<String>> parameters)

The parameters for the documents runtime configuration.

Parameters:

parameters - The parameters for the documents runtime configuration.

Returns:

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

targets

CreateAssociationRequest.Builder targets(Collection<Target> targets)

The targets (either instances or tags) for the association.

Parameters:

targets - The targets (either instances or tags) for the association.

Returns:

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

targets

CreateAssociationRequest.Builder targets(Target... targets)

The targets (either instances or tags) for the association.

Parameters:

targets - The targets (either instances or tags) for the association.

Returns:

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

targets

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

The targets (either instances or tags) for 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)

scheduleExpression

CreateAssociationRequest.Builder scheduleExpression(String scheduleExpression)

A cron expression when the association will be applied to the target(s).

Parameters:

scheduleExpression - A cron expression when the association will be applied to the target(s).

Returns:

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

outputLocation

CreateAssociationRequest.Builder outputLocation(InstanceAssociationOutputLocation outputLocation)

An Amazon S3 bucket where you want to store the output details of the request.

Parameters:

outputLocation - An Amazon S3 bucket where you want to store the output details of the request.

Returns:

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

outputLocation

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

An Amazon S3 bucket where you want to store the output details of the 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)

associationName

CreateAssociationRequest.Builder associationName(String associationName)

Specify a descriptive name for the association.

Parameters:

associationName - Specify a descriptive name for the association.

Returns:

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

maxErrors

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

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

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

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

complianceSeverity

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

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

overrideConfiguration

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

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