software.amazon.awssdk.services.ssm.model

Interface AssociationDescription.Builder

All Superinterfaces:

CopyableBuilder<AssociationDescription.Builder,AssociationDescription>, SdkBuilder<AssociationDescription.Builder,AssociationDescription>

Enclosing class:

AssociationDescription

public static interface AssociationDescription.Builder
extends CopyableBuilder<AssociationDescription.Builder,AssociationDescription>

Method Summary

Modifier and Type	Method and Description
AssociationDescription.Builder	associationId(String associationId) The association ID.
AssociationDescription.Builder	associationName(String associationName) The association name.
AssociationDescription.Builder	associationVersion(String associationVersion) The association version.
AssociationDescription.Builder	date(Instant date) The date when the association was made.
AssociationDescription.Builder	documentVersion(String documentVersion) The document version.
AssociationDescription.Builder	instanceId(String instanceId) The ID of the instance.
AssociationDescription.Builder	lastExecutionDate(Instant lastExecutionDate) The date on which the association was last run.
AssociationDescription.Builder	lastSuccessfulExecutionDate(Instant lastSuccessfulExecutionDate) The last date on which the association was successfully run.
AssociationDescription.Builder	lastUpdateAssociationDate(Instant lastUpdateAssociationDate) The date when the association was last updated.
AssociationDescription.Builder	name(String name) The name of the Systems Manager document.
default AssociationDescription.Builder	outputLocation(Consumer<InstanceAssociationOutputLocation.Builder> outputLocation) An Amazon S3 bucket where you want to store the output details of the request.
AssociationDescription.Builder	outputLocation(InstanceAssociationOutputLocation outputLocation) An Amazon S3 bucket where you want to store the output details of the request.
AssociationDescription.Builder	overview(AssociationOverview overview) Information about the association.
default AssociationDescription.Builder	overview(Consumer<AssociationOverview.Builder> overview) Information about the association.
AssociationDescription.Builder	parameters(Map<String,? extends Collection<String>> parameters) A description of the parameters for a document.
AssociationDescription.Builder	scheduleExpression(String scheduleExpression) A cron expression that specifies a schedule when the association runs.
AssociationDescription.Builder	status(AssociationStatus status) The association status.
default AssociationDescription.Builder	status(Consumer<AssociationStatus.Builder> status) The association status.
AssociationDescription.Builder	targets(Collection<Target> targets) The instances targeted by the request.
AssociationDescription.Builder	targets(Consumer<Target.Builder>... targets) The instances targeted by the request.
AssociationDescription.Builder	targets(Target... targets) The instances targeted by the request.

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

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

instanceId

AssociationDescription.Builder instanceId(String instanceId)

The ID of the instance.

Parameters:

instanceId - The ID of the instance.

Returns:

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

associationVersion

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

date

AssociationDescription.Builder date(Instant date)

The date when the association was made.

Parameters:

date - The date when the association was made.

Returns:

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

lastUpdateAssociationDate

AssociationDescription.Builder lastUpdateAssociationDate(Instant lastUpdateAssociationDate)

The date when the association was last updated.

Parameters:

lastUpdateAssociationDate - The date when the association was last updated.

Returns:

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

status

AssociationDescription.Builder status(AssociationStatus status)

The association status.

Parameters:

status - The association status.

Returns:

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

status

default AssociationDescription.Builder status(Consumer<AssociationStatus.Builder> status)

The association status.

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

Parameters:

status - a consumer that will call methods on AssociationStatus.Builder

Returns:

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

See Also:

status(AssociationStatus)

overview

AssociationDescription.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 AssociationDescription.Builder overview(Consumer<AssociationOverview.Builder> overview)

Information about the association.

This is a convenience 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)

documentVersion

AssociationDescription.Builder documentVersion(String documentVersion)

The document version.

Parameters:

documentVersion - The document version.

Returns:

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

parameters

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

A description of the parameters for a document.

Parameters:

parameters - A description of the parameters for a document.

Returns:

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

associationId

AssociationDescription.Builder associationId(String associationId)

The association ID.

Parameters:

associationId - The association ID.

Returns:

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

targets

AssociationDescription.Builder targets(Collection<Target> targets)

The instances targeted by the request.

Parameters:

targets - The instances targeted by the request.

Returns:

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

targets

AssociationDescription.Builder targets(Target... targets)

The instances targeted by the request.

Parameters:

targets - The instances targeted by the request.

Returns:

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

targets

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

The instances targeted by the request.

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

AssociationDescription.Builder scheduleExpression(String scheduleExpression)

A cron expression that specifies a schedule when the association runs.

Parameters:

scheduleExpression - A cron expression that specifies a schedule when the association runs.

Returns:

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

outputLocation

AssociationDescription.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 AssociationDescription.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)

lastExecutionDate

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

lastSuccessfulExecutionDate

AssociationDescription.Builder lastSuccessfulExecutionDate(Instant lastSuccessfulExecutionDate)

The last date on which the association was successfully run.

Parameters:

lastSuccessfulExecutionDate - The last date on which the association was successfully run.

Returns:

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

associationName

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