software.amazon.awssdk.services.ssm.model

Interface CreateAssociationRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateAssociationRequest.Builder,CreateAssociationRequest>, SdkBuilder<CreateAssociationRequest.Builder,CreateAssociationRequest>, SdkPojo, SdkRequest.Builder, SsmRequest.Builder

Enclosing class:

CreateAssociationRequest

public static interface CreateAssociationRequest.Builder
extends SsmRequest.Builder, SdkPojo, CopyableBuilder<CreateAssociationRequest.Builder,CreateAssociationRequest>

Method Summary

Modifier and Type	Method and Description
CreateAssociationRequest.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.
CreateAssociationRequest.Builder	associationName(String associationName) Specify a descriptive name for the association.
CreateAssociationRequest.Builder	automationTargetParameterName(String automationTargetParameterName) Specify the target for the association.
CreateAssociationRequest.Builder	complianceSeverity(AssociationComplianceSeverity complianceSeverity) The severity level to assign to the association.
CreateAssociationRequest.Builder	complianceSeverity(String complianceSeverity) The severity level to assign to 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	maxConcurrency(String maxConcurrency) The maximum number of targets allowed to run the association at the same time.
CreateAssociationRequest.Builder	maxErrors(String maxErrors) The number of errors that are allowed before the system stops sending requests to run the association on additional targets.
CreateAssociationRequest.Builder	name(String name) The name of the SSM document that contains the configuration information for the instance.
default CreateAssociationRequest.Builder	outputLocation(Consumer<InstanceAssociationOutputLocation.Builder> outputLocation) An S3 bucket where you want to store the output details of the request.
CreateAssociationRequest.Builder	outputLocation(InstanceAssociationOutputLocation outputLocation) An S3 bucket where you want to store the output details of the request.
CreateAssociationRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateAssociationRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateAssociationRequest.Builder	parameters(Map<String,? extends Collection<String>> parameters) The parameters for the runtime configuration of the document.
CreateAssociationRequest.Builder	scheduleExpression(String scheduleExpression) A cron expression when the association will be applied to the target(s).
CreateAssociationRequest.Builder	syncCompliance(AssociationSyncCompliance syncCompliance) The mode for generating association compliance.
CreateAssociationRequest.Builder	syncCompliance(String syncCompliance) The mode for generating association compliance.
CreateAssociationRequest.Builder	targetLocations(Collection<TargetLocation> targetLocations) A location is a combination of AWS Regions and AWS accounts where you want to run the association.
CreateAssociationRequest.Builder	targetLocations(Consumer<TargetLocation.Builder>... targetLocations) A location is a combination of AWS Regions and AWS accounts where you want to run the association.
CreateAssociationRequest.Builder	targetLocations(TargetLocation... targetLocations) A location is a combination of AWS Regions and AWS accounts where you want to run the association.
CreateAssociationRequest.Builder	targets(Collection<Target> targets) The targets for the association.
CreateAssociationRequest.Builder	targets(Consumer<Target.Builder>... targets) The targets for the association.
CreateAssociationRequest.Builder	targets(Target... targets) The targets 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

overrideConfiguration

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

CreateAssociationRequest.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:partition: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:partition: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.

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.

InstanceId has been deprecated. To specify an instance ID for an association, use the Targets parameter. Requests that include the parameter InstanceID with SSM documents that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId, you cannot use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.

Parameters:

instanceId - The instance ID.

InstanceId has been deprecated. To specify an instance ID for an association, use the Targets parameter. Requests that include the parameter InstanceID with SSM documents that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId, you cannot use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.

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 runtime configuration of the document.

Parameters:

parameters - The parameters for the runtime configuration of the document.

Returns:

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

targets

CreateAssociationRequest.Builder targets(Collection<Target> targets)

The targets for the association. You can target instances by using tags, AWS Resource Groups, all instances in an AWS account, or individual instance IDs. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the AWS Systems Manager User Guide.

Parameters:

targets - The targets for the association. You can target instances by using tags, AWS Resource Groups, all instances in an AWS account, or individual instance IDs. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the AWS Systems Manager User Guide.

Returns:

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

targets

CreateAssociationRequest.Builder targets(Target... targets)

The targets for the association. You can target instances by using tags, AWS Resource Groups, all instances in an AWS account, or individual instance IDs. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the AWS Systems Manager User Guide.

Parameters:

targets - The targets for the association. You can target instances by using tags, AWS Resource Groups, all instances in an AWS account, or individual instance IDs. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the AWS Systems Manager User Guide.

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 for the association. You can target instances by using tags, AWS Resource Groups, all instances in an AWS account, or individual instance IDs. For more information about choosing targets for an association, see Using targets and rate controls with State Manager associations in the AWS Systems Manager User Guide.

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

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.

automationTargetParameterName

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

maxErrors

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

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

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

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

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

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

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

targetLocations

CreateAssociationRequest.Builder targetLocations(Collection<TargetLocation> targetLocations)

A location is a combination of AWS Regions and AWS accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts.

Parameters:

targetLocations - A location is a combination of AWS Regions and AWS accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts.

Returns:

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

targetLocations

CreateAssociationRequest.Builder targetLocations(TargetLocation... targetLocations)

A location is a combination of AWS Regions and AWS accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts.

Parameters:

targetLocations - A location is a combination of AWS Regions and AWS accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts.

Returns:

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

targetLocations

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

A location is a combination of AWS Regions and AWS accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts.

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)

overrideConfiguration

CreateAssociationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateAssociationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

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

Returns:

This object for method chaining.