software.amazon.awssdk.services.ssm.model

Interface AssociationDescription.Builder

All Superinterfaces:

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

Enclosing class:

AssociationDescription

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

Method Summary

Modifier and Type	Method and Description
AssociationDescription.Builder	applyOnlyAtCronInterval(Boolean applyOnlyAtCronInterval) By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified.
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	automationTargetParameterName(String automationTargetParameterName) Choose the parameter that will define how your automation will branch out.
AssociationDescription.Builder	calendarNames(Collection<String> calendarNames) The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under.
AssociationDescription.Builder	calendarNames(String... calendarNames) The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under.
AssociationDescription.Builder	complianceSeverity(AssociationComplianceSeverity complianceSeverity) The severity level that is assigned to the association.
AssociationDescription.Builder	complianceSeverity(String complianceSeverity) The severity level that is assigned to the association.
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 instance ID.
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	maxConcurrency(String maxConcurrency) The maximum number of targets allowed to run the association at the same time.
AssociationDescription.Builder	maxErrors(String maxErrors) The number of errors that are allowed before the system stops sending requests to run the association on additional targets.
AssociationDescription.Builder	name(String name) The name of the SSM document.
default AssociationDescription.Builder	outputLocation(Consumer<InstanceAssociationOutputLocation.Builder> outputLocation) An S3 bucket where you want to store the output details of the request.
AssociationDescription.Builder	outputLocation(InstanceAssociationOutputLocation outputLocation) An 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	syncCompliance(AssociationSyncCompliance syncCompliance) The mode for generating association compliance.
AssociationDescription.Builder	syncCompliance(String syncCompliance) The mode for generating association compliance.
AssociationDescription.Builder	targetLocations(Collection<TargetLocation> targetLocations) The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.
AssociationDescription.Builder	targetLocations(Consumer<TargetLocation.Builder>... targetLocations) The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.
AssociationDescription.Builder	targetLocations(TargetLocation... targetLocations) The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.
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.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

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

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

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.

automationTargetParameterName

AssociationDescription.Builder automationTargetParameterName(String automationTargetParameterName)

Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.

Parameters:

automationTargetParameterName - Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.

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 S3 bucket where you want to store the output details of the request.

Parameters:

outputLocation - An 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 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.

maxErrors

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

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

AssociationDescription.Builder complianceSeverity(String complianceSeverity)

The severity level that is assigned to the association.

Parameters:

complianceSeverity - The severity level that is assigned to the association.

Returns:

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

See Also:

AssociationComplianceSeverity, AssociationComplianceSeverity

complianceSeverity

AssociationDescription.Builder complianceSeverity(AssociationComplianceSeverity complianceSeverity)

The severity level that is assigned to the association.

Parameters:

complianceSeverity - The severity level that is assigned to the association.

Returns:

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

See Also:

AssociationComplianceSeverity, AssociationComplianceSeverity

syncCompliance

AssociationDescription.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 operation. In this case, compliance data isn't managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

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 operation. In this case, compliance data isn't managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

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

AssociationDescription.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 operation. In this case, compliance data isn't managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

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 operation. In this case, compliance data isn't managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

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

AssociationDescription.Builder applyOnlyAtCronInterval(Boolean applyOnlyAtCronInterval)

By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.

Parameters:

applyOnlyAtCronInterval - By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.

Returns:

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

calendarNames

AssociationDescription.Builder calendarNames(Collection<String> calendarNames)

The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.

Parameters:

calendarNames - The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.

Returns:

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

calendarNames

AssociationDescription.Builder calendarNames(String... calendarNames)

The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.

Parameters:

calendarNames - The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.

Returns:

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

targetLocations

AssociationDescription.Builder targetLocations(Collection<TargetLocation> targetLocations)

The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.

Parameters:

targetLocations - The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.

Returns:

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

targetLocations

AssociationDescription.Builder targetLocations(TargetLocation... targetLocations)

The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.

Parameters:

targetLocations - The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.

Returns:

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

targetLocations

AssociationDescription.Builder targetLocations(Consumer<TargetLocation.Builder>... targetLocations)

The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run 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 #targetLocations(List).

Parameters:

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

#targetLocations(List)