software.amazon.awssdk.services.ssm.model

Interface CreateAssociationRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<CreateAssociationRequest.Builder,CreateAssociationRequest>, SdkBuilder<CreateAssociationRequest.Builder,CreateAssociationRequest>, SdkRequest.Builder, SSMRequest.Builder

Enclosing class:

CreateAssociationRequest

public static interface CreateAssociationRequest.Builder
extends SSMRequest.Builder, 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	documentVersion(String documentVersion) The document version you want to associate with the target(s).
CreateAssociationRequest.Builder	instanceId(String instanceId) The instance ID.
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	parameters(Map<String,? extends Collection<String>> parameters) The parameters for the documents runtime configuration.
CreateAssociationRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
CreateAssociationRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override 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

requestOverrideConfig

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

copy

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

apply, 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.

requestOverrideConfig

CreateAssociationRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

CreateAssociationRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

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

Returns:

This object for method chaining.