software.amazon.awssdk.services.ssm.model

Interface SendCommandRequest.Builder

All Superinterfaces:

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

Enclosing class:

SendCommandRequest

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

Method Summary

Modifier and Type	Method and Description
SendCommandRequest.Builder	cloudWatchOutputConfig(CloudWatchOutputConfig cloudWatchOutputConfig) Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs.
default SendCommandRequest.Builder	cloudWatchOutputConfig(Consumer<CloudWatchOutputConfig.Builder> cloudWatchOutputConfig) Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs.
SendCommandRequest.Builder	comment(String comment) User-specified information about the command, such as a brief description of what the command should do.
SendCommandRequest.Builder	documentHash(String documentHash) The Sha256 or Sha1 hash created by the system when the document was created.
SendCommandRequest.Builder	documentHashType(DocumentHashType documentHashType) Sha256 or Sha1.
SendCommandRequest.Builder	documentHashType(String documentHashType) Sha256 or Sha1.
SendCommandRequest.Builder	documentName(String documentName) The name of the Amazon Web Services Systems Manager document (SSM document) to run.
SendCommandRequest.Builder	documentVersion(String documentVersion) The SSM document version to use in the request.
SendCommandRequest.Builder	instanceIds(Collection<String> instanceIds) The IDs of the instances where the command should run.
SendCommandRequest.Builder	instanceIds(String... instanceIds) The IDs of the instances where the command should run.
SendCommandRequest.Builder	maxConcurrency(String maxConcurrency) (Optional) The maximum number of instances that are allowed to run the command at the same time.
SendCommandRequest.Builder	maxErrors(String maxErrors) The maximum number of errors allowed without the command failing.
default SendCommandRequest.Builder	notificationConfig(Consumer<NotificationConfig.Builder> notificationConfig) Configurations for sending notifications.
SendCommandRequest.Builder	notificationConfig(NotificationConfig notificationConfig) Configurations for sending notifications.
SendCommandRequest.Builder	outputS3BucketName(String outputS3BucketName) The name of the S3 bucket where command execution responses should be stored.
SendCommandRequest.Builder	outputS3KeyPrefix(String outputS3KeyPrefix) The directory structure within the S3 bucket where the responses should be stored.
SendCommandRequest.Builder	outputS3Region(String outputS3Region) (Deprecated) You can no longer specify this parameter.
SendCommandRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
SendCommandRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
SendCommandRequest.Builder	parameters(Map<String,? extends Collection<String>> parameters) The required and optional parameters specified in the document being run.
SendCommandRequest.Builder	serviceRoleArn(String serviceRoleArn) The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.
SendCommandRequest.Builder	targets(Collection<Target> targets) An array of search criteria that targets instances using a Key,Value combination that you specify.
SendCommandRequest.Builder	targets(Consumer<Target.Builder>... targets) An array of search criteria that targets instances using a Key,Value combination that you specify.
SendCommandRequest.Builder	targets(Target... targets) An array of search criteria that targets instances using a Key,Value combination that you specify.
SendCommandRequest.Builder	timeoutSeconds(Integer timeoutSeconds) If this time is reached and the command hasn't already started running, it won't run.

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

instanceIds

SendCommandRequest.Builder instanceIds(Collection<String> instanceIds)

The IDs of the instances where the command should run. Specifying instance IDs is most useful when you are targeting a limited number of instances, though you can specify up to 50 IDs.

To target a larger number of instances, or if you prefer not to list individual instance IDs, we recommend using the Targets option instead. Using Targets, which accepts tag key-value pairs to identify the instances to send commands to, you can a send command to tens, hundreds, or thousands of instances at once.

For more information about how to use targets, see Using targets and rate controls to send commands to a fleet in the Amazon Web Services Systems Manager User Guide.

Parameters:

instanceIds - The IDs of the instances where the command should run. Specifying instance IDs is most useful when you are targeting a limited number of instances, though you can specify up to 50 IDs.

To target a larger number of instances, or if you prefer not to list individual instance IDs, we recommend using the Targets option instead. Using Targets, which accepts tag key-value pairs to identify the instances to send commands to, you can a send command to tens, hundreds, or thousands of instances at once.

For more information about how to use targets, see Using targets and rate controls to send commands to a fleet in the Amazon Web Services Systems Manager User Guide.

Returns:

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

instanceIds

SendCommandRequest.Builder instanceIds(String... instanceIds)

The IDs of the instances where the command should run. Specifying instance IDs is most useful when you are targeting a limited number of instances, though you can specify up to 50 IDs.

To target a larger number of instances, or if you prefer not to list individual instance IDs, we recommend using the Targets option instead. Using Targets, which accepts tag key-value pairs to identify the instances to send commands to, you can a send command to tens, hundreds, or thousands of instances at once.

For more information about how to use targets, see Using targets and rate controls to send commands to a fleet in the Amazon Web Services Systems Manager User Guide.

Parameters:

instanceIds - The IDs of the instances where the command should run. Specifying instance IDs is most useful when you are targeting a limited number of instances, though you can specify up to 50 IDs.

To target a larger number of instances, or if you prefer not to list individual instance IDs, we recommend using the Targets option instead. Using Targets, which accepts tag key-value pairs to identify the instances to send commands to, you can a send command to tens, hundreds, or thousands of instances at once.

For more information about how to use targets, see Using targets and rate controls to send commands to a fleet in the Amazon Web Services Systems Manager User Guide.

Returns:

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

targets

SendCommandRequest.Builder targets(Collection<Target> targets)

An array of search criteria that targets instances using a Key,Value combination that you specify. Specifying targets is most useful when you want to send a command to a large number of instances at once. Using Targets, which accepts tag key-value pairs to identify instances, you can send a command to tens, hundreds, or thousands of instances at once.

To send a command to a smaller number of instances, you can use the InstanceIds option instead.

For more information about how to use targets, see Sending commands to a fleet in the Amazon Web Services Systems Manager User Guide.

Parameters:

targets - An array of search criteria that targets instances using a Key,Value combination that you specify. Specifying targets is most useful when you want to send a command to a large number of instances at once. Using Targets, which accepts tag key-value pairs to identify instances, you can send a command to tens, hundreds, or thousands of instances at once.

To send a command to a smaller number of instances, you can use the InstanceIds option instead.

For more information about how to use targets, see Sending commands to a fleet in the Amazon Web Services Systems Manager User Guide.

Returns:

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

targets

SendCommandRequest.Builder targets(Target... targets)

An array of search criteria that targets instances using a Key,Value combination that you specify. Specifying targets is most useful when you want to send a command to a large number of instances at once. Using Targets, which accepts tag key-value pairs to identify instances, you can send a command to tens, hundreds, or thousands of instances at once.

To send a command to a smaller number of instances, you can use the InstanceIds option instead.

For more information about how to use targets, see Sending commands to a fleet in the Amazon Web Services Systems Manager User Guide.

Parameters:

targets - An array of search criteria that targets instances using a Key,Value combination that you specify. Specifying targets is most useful when you want to send a command to a large number of instances at once. Using Targets, which accepts tag key-value pairs to identify instances, you can send a command to tens, hundreds, or thousands of instances at once.

To send a command to a smaller number of instances, you can use the InstanceIds option instead.

For more information about how to use targets, see Sending commands to a fleet in the Amazon Web Services Systems Manager User Guide.

Returns:

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

targets

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

An array of search criteria that targets instances using a Key,Value combination that you specify. Specifying targets is most useful when you want to send a command to a large number of instances at once. Using Targets, which accepts tag key-value pairs to identify instances, you can send a command to tens, hundreds, or thousands of instances at once.

To send a command to a smaller number of instances, you can use the InstanceIds option instead.

For more information about how to use targets, see Sending commands to a fleet in the Amazon Web Services 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)

documentName

SendCommandRequest.Builder documentName(String documentName)

The name of the Amazon Web Services Systems Manager document (SSM document) to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document Amazon Resource Name (ARN). For more information about how to use shared documents, see Using shared SSM documents in the Amazon Web Services Systems Manager User Guide.

If you specify a document name or ARN that hasn't been shared with your account, you receive an InvalidDocument error.

Parameters:

documentName - The name of the Amazon Web Services Systems Manager document (SSM document) to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document Amazon Resource Name (ARN). For more information about how to use shared documents, see Using shared SSM documents in the Amazon Web Services Systems Manager User Guide.

If you specify a document name or ARN that hasn't been shared with your account, you receive an InvalidDocument error.

Returns:

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

documentVersion

SendCommandRequest.Builder documentVersion(String documentVersion)

The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Command Line Interface (Amazon Web Services CLI), then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:

--document-version "\$DEFAULT"

--document-version "\$LATEST"

--document-version "3"

Parameters:

documentVersion - The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Command Line Interface (Amazon Web Services CLI), then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:

--document-version "\$DEFAULT"

--document-version "\$LATEST"

--document-version "3"

Returns:

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

documentHash

SendCommandRequest.Builder documentHash(String documentHash)

The Sha256 or Sha1 hash created by the system when the document was created.

Sha1 hashes have been deprecated.

Parameters:

documentHash - The Sha256 or Sha1 hash created by the system when the document was created.

Sha1 hashes have been deprecated.

Returns:

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

documentHashType

SendCommandRequest.Builder documentHashType(String documentHashType)

Sha256 or Sha1.

Sha1 hashes have been deprecated.

Parameters:

documentHashType - Sha256 or Sha1.

Sha1 hashes have been deprecated.

Returns:

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

See Also:

DocumentHashType, DocumentHashType

documentHashType

SendCommandRequest.Builder documentHashType(DocumentHashType documentHashType)

Sha256 or Sha1.

Sha1 hashes have been deprecated.

Parameters:

documentHashType - Sha256 or Sha1.

Sha1 hashes have been deprecated.

Returns:

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

See Also:

DocumentHashType, DocumentHashType

timeoutSeconds

SendCommandRequest.Builder timeoutSeconds(Integer timeoutSeconds)

If this time is reached and the command hasn't already started running, it won't run.

Parameters:

timeoutSeconds - If this time is reached and the command hasn't already started running, it won't run.

Returns:

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

comment

SendCommandRequest.Builder comment(String comment)

User-specified information about the command, such as a brief description of what the command should do.

Parameters:

comment - User-specified information about the command, such as a brief description of what the command should do.

Returns:

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

parameters

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

The required and optional parameters specified in the document being run.

Parameters:

parameters - The required and optional parameters specified in the document being run.

Returns:

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

outputS3Region

SendCommandRequest.Builder outputS3Region(String outputS3Region)

(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon Web Services Region of the S3 bucket.

Parameters:

outputS3Region - (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon Web Services Region of the S3 bucket.

Returns:

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

outputS3BucketName

SendCommandRequest.Builder outputS3BucketName(String outputS3BucketName)

The name of the S3 bucket where command execution responses should be stored.

Parameters:

outputS3BucketName - The name of the S3 bucket where command execution responses should be stored.

Returns:

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

outputS3KeyPrefix

SendCommandRequest.Builder outputS3KeyPrefix(String outputS3KeyPrefix)

The directory structure within the S3 bucket where the responses should be stored.

Parameters:

outputS3KeyPrefix - The directory structure within the S3 bucket where the responses should be stored.

Returns:

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

maxConcurrency

SendCommandRequest.Builder maxConcurrency(String maxConcurrency)

(Optional) The maximum number of instances that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using concurrency controls in the Amazon Web Services Systems Manager User Guide.

Parameters:

maxConcurrency - (Optional) The maximum number of instances that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using concurrency controls in the Amazon Web Services Systems Manager User Guide.

Returns:

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

maxErrors

SendCommandRequest.Builder maxErrors(String maxErrors)

The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 0. For more information about how to use MaxErrors, see Using error controls in the Amazon Web Services Systems Manager User Guide.

Parameters:

maxErrors - The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 0. For more information about how to use MaxErrors, see Using error controls in the Amazon Web Services Systems Manager User Guide.

Returns:

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

serviceRoleArn

SendCommandRequest.Builder serviceRoleArn(String serviceRoleArn)

The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.

Parameters:

serviceRoleArn - The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.

Returns:

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

notificationConfig

SendCommandRequest.Builder notificationConfig(NotificationConfig notificationConfig)

Configurations for sending notifications.

Parameters:

notificationConfig - Configurations for sending notifications.

Returns:

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

notificationConfig

default SendCommandRequest.Builder notificationConfig(Consumer<NotificationConfig.Builder> notificationConfig)

Configurations for sending notifications.

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

Parameters:

notificationConfig - a consumer that will call methods on NotificationConfig.Builder

Returns:

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

See Also:

notificationConfig(NotificationConfig)

cloudWatchOutputConfig

SendCommandRequest.Builder cloudWatchOutputConfig(CloudWatchOutputConfig cloudWatchOutputConfig)

Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a capability of Amazon Web Services Systems Manager.

Parameters:

cloudWatchOutputConfig - Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a capability of Amazon Web Services Systems Manager.

Returns:

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

cloudWatchOutputConfig

default SendCommandRequest.Builder cloudWatchOutputConfig(Consumer<CloudWatchOutputConfig.Builder> cloudWatchOutputConfig)

Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a capability of Amazon Web Services Systems Manager.

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

Parameters:

cloudWatchOutputConfig - a consumer that will call methods on CloudWatchOutputConfig.Builder

Returns:

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

See Also:

cloudWatchOutputConfig(CloudWatchOutputConfig)

overrideConfiguration

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

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