software.amazon.awssdk.services.ssm.model

Interface CreateAssociationBatchRequestEntry.Builder

All Superinterfaces:

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

Enclosing class:

CreateAssociationBatchRequestEntry

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

Method Summary

Modifier and Type	Method and Description
CreateAssociationBatchRequestEntry.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.
CreateAssociationBatchRequestEntry.Builder	associationName(String associationName) Specify a descriptive name for the association.
CreateAssociationBatchRequestEntry.Builder	automationTargetParameterName(String automationTargetParameterName) Specify the target for the association.
CreateAssociationBatchRequestEntry.Builder	complianceSeverity(AssociationComplianceSeverity complianceSeverity) The severity level to assign to the association.
CreateAssociationBatchRequestEntry.Builder	complianceSeverity(String complianceSeverity) The severity level to assign to the association.
CreateAssociationBatchRequestEntry.Builder	documentVersion(String documentVersion) The document version.
CreateAssociationBatchRequestEntry.Builder	instanceId(String instanceId) The ID of the instance.
CreateAssociationBatchRequestEntry.Builder	maxConcurrency(String maxConcurrency) The maximum number of targets allowed to run the association at the same time.
CreateAssociationBatchRequestEntry.Builder	maxErrors(String maxErrors) The number of errors that are allowed before the system stops sending requests to run the association on additional targets.
CreateAssociationBatchRequestEntry.Builder	name(String name) The name of the SSM document that contains the configuration information for the instance.
default CreateAssociationBatchRequestEntry.Builder	outputLocation(Consumer<InstanceAssociationOutputLocation.Builder> outputLocation) An S3 bucket where you want to store the results of this request.
CreateAssociationBatchRequestEntry.Builder	outputLocation(InstanceAssociationOutputLocation outputLocation) An S3 bucket where you want to store the results of this request.
CreateAssociationBatchRequestEntry.Builder	parameters(Map<String,? extends Collection<String>> parameters) A description of the parameters for a document.
CreateAssociationBatchRequestEntry.Builder	scheduleExpression(String scheduleExpression) A cron expression that specifies a schedule when the association runs.
CreateAssociationBatchRequestEntry.Builder	syncCompliance(AssociationSyncCompliance syncCompliance) The mode for generating association compliance.
CreateAssociationBatchRequestEntry.Builder	syncCompliance(String syncCompliance) The mode for generating association compliance.
CreateAssociationBatchRequestEntry.Builder	targets(Collection<Target> targets) The instances targeted by the request.
CreateAssociationBatchRequestEntry.Builder	targets(Consumer<Target.Builder>... targets) The instances targeted by the request.
CreateAssociationBatchRequestEntry.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

CreateAssociationBatchRequestEntry.Builder name(String name)

The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.

You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account.

For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format:

arn:aws:ssm:region:account-id:document/document-name

For example:

arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document

For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.

Parameters:

name - The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.

You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account.

For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format:

arn:aws:ssm:region:account-id:document/document-name

For example:

arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document

For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.

Returns:

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

instanceId

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

parameters

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

automationTargetParameterName

CreateAssociationBatchRequestEntry.Builder automationTargetParameterName(String automationTargetParameterName)

Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.

Parameters:

automationTargetParameterName - Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.

Returns:

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

documentVersion

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

targets

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

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

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

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

CreateAssociationBatchRequestEntry.Builder outputLocation(InstanceAssociationOutputLocation outputLocation)

An S3 bucket where you want to store the results of this request.

Parameters:

outputLocation - An S3 bucket where you want to store the results of this request.

Returns:

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

outputLocation

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

An S3 bucket where you want to store the results of this 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

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

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

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

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

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

syncCompliance

CreateAssociationBatchRequestEntry.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 action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.

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 action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.

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

CreateAssociationBatchRequestEntry.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 action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.

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 action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.

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

CreateAssociationBatchRequestEntry.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 is not 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 is not supported for rate expressions.

Returns:

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