software.amazon.awssdk.services.ssm.model

Interface Association.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Association.Builder,Association>, SdkBuilder<Association.Builder,Association>, SdkPojo

Enclosing class:

Association

public static interface Association.Builder
extends SdkPojo, CopyableBuilder<Association.Builder,Association>

Method Summary

Modifier and Type	Method and Description
Association.Builder	associationId(String associationId) The ID created by the system when you create an association.
Association.Builder	associationName(String associationName) The association name.
Association.Builder	associationVersion(String associationVersion) The association version.
Association.Builder	documentVersion(String documentVersion) The version of the document used in the association.
Association.Builder	instanceId(String instanceId) The managed node ID.
Association.Builder	lastExecutionDate(Instant lastExecutionDate) The date on which the association was last run.
Association.Builder	name(String name) The name of the SSM document.
Association.Builder	overview(AssociationOverview overview) Information about the association.
default Association.Builder	overview(Consumer<AssociationOverview.Builder> overview) Information about the association.
Association.Builder	scheduleExpression(String scheduleExpression) A cron expression that specifies a schedule when the association runs.
Association.Builder	scheduleOffset(Integer scheduleOffset) Number of days to wait after the scheduled day to run an association.
Association.Builder	targetMaps(Collection<? extends Map<String,? extends Collection<String>>> targetMaps) A key-value mapping of document parameters to target resources.
Association.Builder	targetMaps(Map<String,? extends Collection<String>>... targetMaps) A key-value mapping of document parameters to target resources.
Association.Builder	targets(Collection<Target> targets) The managed nodes targeted by the request to create an association.
Association.Builder	targets(Consumer<Target.Builder>... targets) The managed nodes targeted by the request to create an association.
Association.Builder	targets(Target... targets) The managed nodes targeted by the request to create an association.

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

name

Association.Builder name(String name)

The name of the SSM document.

Parameters:

name - The name of the SSM document.

Returns:

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

instanceId

Association.Builder instanceId(String instanceId)

The managed node ID.

Parameters:

instanceId - The managed node ID.

Returns:

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

associationId

Association.Builder associationId(String associationId)

The ID created by the system when you create an association. An association is a binding between a document and a set of targets with a schedule.

Parameters:

associationId - The ID created by the system when you create an association. An association is a binding between a document and a set of targets with a schedule.

Returns:

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

associationVersion

Association.Builder associationVersion(String associationVersion)

The association version.

Parameters:

associationVersion - The association version.

Returns:

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

documentVersion

Association.Builder documentVersion(String documentVersion)

The version of the document used in the association. If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.

State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the default version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to default.

Parameters:

documentVersion - The version of the document used in the association. If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.

State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the default version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to default.

Returns:

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

targets

Association.Builder targets(Collection<Target> targets)

The managed nodes targeted by the request to create an association. You can target all managed nodes in an Amazon Web Services account by specifying the InstanceIds key with a value of *.

Parameters:

targets - The managed nodes targeted by the request to create an association. You can target all managed nodes in an Amazon Web Services account by specifying the InstanceIds key with a value of *.

Returns:

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

targets

Association.Builder targets(Target... targets)

The managed nodes targeted by the request to create an association. You can target all managed nodes in an Amazon Web Services account by specifying the InstanceIds key with a value of *.

Parameters:

targets - The managed nodes targeted by the request to create an association. You can target all managed nodes in an Amazon Web Services account by specifying the InstanceIds key with a value of *.

Returns:

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

targets

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

The managed nodes targeted by the request to create an association. You can target all managed nodes in an Amazon Web Services account by specifying the InstanceIds key with a value of *.

This is a convenience method that creates an instance of the Target.Builder avoiding the need to create one manually via Target.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #targets(List).

Parameters:

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

Returns:

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

See Also:

#targets(java.util.Collection)

lastExecutionDate

Association.Builder lastExecutionDate(Instant lastExecutionDate)

The date on which the association was last run.

Parameters:

lastExecutionDate - The date on which the association was last run.

Returns:

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

overview

Association.Builder overview(AssociationOverview overview)

Information about the association.

Parameters:

overview - Information about the association.

Returns:

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

overview

default Association.Builder overview(Consumer<AssociationOverview.Builder> overview)

Information about the association.

This is a convenience method that creates an instance of the AssociationOverview.Builder avoiding the need to create one manually via AssociationOverview.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to overview(AssociationOverview).

Parameters:

overview - a consumer that will call methods on AssociationOverview.Builder

Returns:

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

See Also:

overview(AssociationOverview)

scheduleExpression

Association.Builder scheduleExpression(String scheduleExpression)

A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated Universal Time (UTC).

Parameters:

scheduleExpression - A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated Universal Time (UTC).

Returns:

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

associationName

Association.Builder associationName(String associationName)

The association name.

Parameters:

associationName - The association name.

Returns:

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

scheduleOffset

Association.Builder scheduleOffset(Integer scheduleOffset)

Number of days to wait after the scheduled day to run an association.

Parameters:

scheduleOffset - Number of days to wait after the scheduled day to run an association.

Returns:

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

targetMaps

Association.Builder targetMaps(Collection<? extends Map<String,? extends Collection<String>>> targetMaps)

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

Parameters:

targetMaps - A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

Returns:

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

targetMaps

Association.Builder targetMaps(Map<String,? extends Collection<String>>... targetMaps)

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

Parameters:

targetMaps - A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

Returns:

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