Interface SendCommandRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<SendCommandRequest.Builder,
,SendCommandRequest> SdkBuilder<SendCommandRequest.Builder,
,SendCommandRequest> SdkPojo
,SdkRequest.Builder
,SsmRequest.Builder
- Enclosing class:
SendCommandRequest
-
Method Summary
Modifier and TypeMethodDescriptiondefault SendCommandRequest.Builder
alarmConfiguration
(Consumer<AlarmConfiguration.Builder> alarmConfiguration) The CloudWatch alarm you want to apply to your command.alarmConfiguration
(AlarmConfiguration alarmConfiguration) The CloudWatch alarm you want to apply to your command.default SendCommandRequest.Builder
cloudWatchOutputConfig
(Consumer<CloudWatchOutputConfig.Builder> cloudWatchOutputConfig) Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs.cloudWatchOutputConfig
(CloudWatchOutputConfig cloudWatchOutputConfig) Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs.User-specified information about the command, such as a brief description of what the command should do.documentHash
(String documentHash) The Sha256 or Sha1 hash created by the system when the document was created.documentHashType
(String documentHashType) Sha256 or Sha1.documentHashType
(DocumentHashType documentHashType) Sha256 or Sha1.documentName
(String documentName) The name of the Amazon Web Services Systems Manager document (SSM document) to run.documentVersion
(String documentVersion) The SSM document version to use in the request.instanceIds
(String... instanceIds) The IDs of the managed nodes where the command should run.instanceIds
(Collection<String> instanceIds) The IDs of the managed nodes where the command should run.maxConcurrency
(String maxConcurrency) (Optional) The maximum number of managed nodes that are allowed to run the command at the same time.The maximum number of errors allowed without the command failing.default SendCommandRequest.Builder
notificationConfig
(Consumer<NotificationConfig.Builder> notificationConfig) Configurations for sending notifications.notificationConfig
(NotificationConfig notificationConfig) Configurations for sending notifications.outputS3BucketName
(String outputS3BucketName) The name of the S3 bucket where command execution responses should be stored.outputS3KeyPrefix
(String outputS3KeyPrefix) The directory structure within the S3 bucket where the responses should be stored.outputS3Region
(String outputS3Region) (Deprecated) You can no longer specify this parameter.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.parameters
(Map<String, ? extends Collection<String>> parameters) The required and optional parameters specified in the document being run.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.targets
(Collection<Target> targets) An array of search criteria that targets managed nodes using aKey,Value
combination that you specify.targets
(Consumer<Target.Builder>... targets) An array of search criteria that targets managed nodes using aKey,Value
combination that you specify.An array of search criteria that targets managed nodes using aKey,Value
combination that you specify.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.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.services.ssm.model.SsmRequest.Builder
build
-
Method Details
-
instanceIds
The IDs of the managed nodes where the command should run. Specifying managed node IDs is most useful when you are targeting a limited number of managed nodes, though you can specify up to 50 IDs.
To target a larger number of managed nodes, or if you prefer not to list individual node IDs, we recommend using the
Targets
option instead. UsingTargets
, which accepts tag key-value pairs to identify the managed nodes to send commands to, you can a send command to tens, hundreds, or thousands of nodes at once.For more information about how to use targets, see Run commands at scale in the Amazon Web Services Systems Manager User Guide.
- Parameters:
instanceIds
- The IDs of the managed nodes where the command should run. Specifying managed node IDs is most useful when you are targeting a limited number of managed nodes, though you can specify up to 50 IDs.To target a larger number of managed nodes, or if you prefer not to list individual node IDs, we recommend using the
Targets
option instead. UsingTargets
, which accepts tag key-value pairs to identify the managed nodes to send commands to, you can a send command to tens, hundreds, or thousands of nodes at once.For more information about how to use targets, see Run commands at scale 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
The IDs of the managed nodes where the command should run. Specifying managed node IDs is most useful when you are targeting a limited number of managed nodes, though you can specify up to 50 IDs.
To target a larger number of managed nodes, or if you prefer not to list individual node IDs, we recommend using the
Targets
option instead. UsingTargets
, which accepts tag key-value pairs to identify the managed nodes to send commands to, you can a send command to tens, hundreds, or thousands of nodes at once.For more information about how to use targets, see Run commands at scale in the Amazon Web Services Systems Manager User Guide.
- Parameters:
instanceIds
- The IDs of the managed nodes where the command should run. Specifying managed node IDs is most useful when you are targeting a limited number of managed nodes, though you can specify up to 50 IDs.To target a larger number of managed nodes, or if you prefer not to list individual node IDs, we recommend using the
Targets
option instead. UsingTargets
, which accepts tag key-value pairs to identify the managed nodes to send commands to, you can a send command to tens, hundreds, or thousands of nodes at once.For more information about how to use targets, see Run commands at scale 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
An array of search criteria that targets managed nodes 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 managed nodes at once. UsingTargets
, which accepts tag key-value pairs to identify managed nodes, you can send a command to tens, hundreds, or thousands of nodes at once.To send a command to a smaller number of managed nodes, you can use the
InstanceIds
option instead.For more information about how to use targets, see Run commands at scale in the Amazon Web Services Systems Manager User Guide.
- Parameters:
targets
- An array of search criteria that targets managed nodes using aKey,Value
combination that you specify. Specifying targets is most useful when you want to send a command to a large number of managed nodes at once. UsingTargets
, which accepts tag key-value pairs to identify managed nodes, you can send a command to tens, hundreds, or thousands of nodes at once.To send a command to a smaller number of managed nodes, you can use the
InstanceIds
option instead.For more information about how to use targets, see Run commands at scale 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
An array of search criteria that targets managed nodes 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 managed nodes at once. UsingTargets
, which accepts tag key-value pairs to identify managed nodes, you can send a command to tens, hundreds, or thousands of nodes at once.To send a command to a smaller number of managed nodes, you can use the
InstanceIds
option instead.For more information about how to use targets, see Run commands at scale in the Amazon Web Services Systems Manager User Guide.
- Parameters:
targets
- An array of search criteria that targets managed nodes using aKey,Value
combination that you specify. Specifying targets is most useful when you want to send a command to a large number of managed nodes at once. UsingTargets
, which accepts tag key-value pairs to identify managed nodes, you can send a command to tens, hundreds, or thousands of nodes at once.To send a command to a smaller number of managed nodes, you can use the
InstanceIds
option instead.For more information about how to use targets, see Run commands at scale 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
An array of search criteria that targets managed nodes 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 managed nodes at once. UsingTargets
, which accepts tag key-value pairs to identify managed nodes, you can send a command to tens, hundreds, or thousands of nodes at once.To send a command to a smaller number of managed nodes, you can use the
InstanceIds
option instead.For more information about how to use targets, see Run commands at scale in the Amazon Web Services Systems Manager User Guide.
This is a convenience method that creates an instance of theTarget.Builder
avoiding the need to create one manually viaTarget.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totargets(List<Target>)
.- Parameters:
targets
- a consumer that will call methods onTarget.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 Sharing 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 Sharing 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
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
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
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
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:
-
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
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
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
(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
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
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
(Optional) The maximum number of managed nodes 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 useMaxConcurrency
, see Using concurrency controls in the Amazon Web Services Systems Manager User Guide.- Parameters:
maxConcurrency
- (Optional) The maximum number of managed nodes 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 is50
. For more information about how to useMaxConcurrency
, 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
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 is0
. For more information about how to useMaxErrors
, 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 ofMaxErrors
, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is0
. For more information about how to useMaxErrors
, 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
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.
This role must provide the
sns:Publish
permission for your notification topic. For information about creating and using this service role, see Monitoring Systems Manager status changes using Amazon SNS notifications in the Amazon Web Services Systems Manager User Guide.- 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.This role must provide the
sns:Publish
permission for your notification topic. For information about creating and using this service role, see Monitoring Systems Manager status changes using Amazon SNS notifications in the Amazon Web Services Systems Manager User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 method that creates an instance of theNotificationConfig.Builder
avoiding the need to create one manually viaNotificationConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tonotificationConfig(NotificationConfig)
.- Parameters:
notificationConfig
- a consumer that will call methods onNotificationConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 method that creates an instance of theCloudWatchOutputConfig.Builder
avoiding the need to create one manually viaCloudWatchOutputConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocloudWatchOutputConfig(CloudWatchOutputConfig)
.- Parameters:
cloudWatchOutputConfig
- a consumer that will call methods onCloudWatchOutputConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
alarmConfiguration
The CloudWatch alarm you want to apply to your command.
- Parameters:
alarmConfiguration
- The CloudWatch alarm you want to apply to your command.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
alarmConfiguration
default SendCommandRequest.Builder alarmConfiguration(Consumer<AlarmConfiguration.Builder> alarmConfiguration) The CloudWatch alarm you want to apply to your command.
This is a convenience method that creates an instance of theAlarmConfiguration.Builder
avoiding the need to create one manually viaAlarmConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toalarmConfiguration(AlarmConfiguration)
.- Parameters:
alarmConfiguration
- a consumer that will call methods onAlarmConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
SendCommandRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-