Command.Builder (AWS Java SDK :: Services :: AWS Simple Systems Management (SSM) 2.16.50 API)

All Superinterfaces:

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

Enclosing class:

Command
```
public static interface Command.Builder
extends SdkPojo, CopyableBuilder<Command.Builder,Command>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Command.Builder`	`cloudWatchOutputConfig(CloudWatchOutputConfig cloudWatchOutputConfig)` CloudWatch Logs information where you want Systems Manager to send the command output.
`default Command.Builder`	`cloudWatchOutputConfig(Consumer<CloudWatchOutputConfig.Builder> cloudWatchOutputConfig)` CloudWatch Logs information where you want Systems Manager to send the command output.
`Command.Builder`	`commandId(String commandId)` A unique identifier for this command.
`Command.Builder`	`comment(String comment)` User-specified information about the command, such as a brief description of what the command should do.
`Command.Builder`	`completedCount(Integer completedCount)` The number of targets for which the command invocation reached a terminal state.
`Command.Builder`	`deliveryTimedOutCount(Integer deliveryTimedOutCount)` The number of targets for which the status is Delivery Timed Out.
`Command.Builder`	`documentName(String documentName)` The name of the document requested for execution.
`Command.Builder`	`documentVersion(String documentVersion)` The SSM document version.
`Command.Builder`	`errorCount(Integer errorCount)` The number of targets for which the status is Failed or Execution Timed Out.
`Command.Builder`	`expiresAfter(Instant expiresAfter)` If this time is reached and the command has not already started running, it will not run.
`Command.Builder`	`instanceIds(Collection<String> instanceIds)` The instance IDs against which this command was requested.
`Command.Builder`	`instanceIds(String... instanceIds)` The instance IDs against which this command was requested.
`Command.Builder`	`maxConcurrency(String maxConcurrency)` The maximum number of instances that are allowed to run the command at the same time.
`Command.Builder`	`maxErrors(String maxErrors)` The maximum number of errors allowed before the system stops sending the command to additional targets.
`default Command.Builder`	`notificationConfig(Consumer<NotificationConfig.Builder> notificationConfig)` Configurations for sending notifications about command status changes.
`Command.Builder`	`notificationConfig(NotificationConfig notificationConfig)` Configurations for sending notifications about command status changes.
`Command.Builder`	`outputS3BucketName(String outputS3BucketName)` The S3 bucket where the responses to the command executions should be stored.
`Command.Builder`	`outputS3KeyPrefix(String outputS3KeyPrefix)` The S3 directory path inside the bucket where the responses to the command executions should be stored.
`Command.Builder`	`outputS3Region(String outputS3Region)` (Deprecated) You can no longer specify this parameter.
`Command.Builder`	`parameters(Map<String,? extends Collection<String>> parameters)` The parameter values to be inserted in the document when running the command.
`Command.Builder`	`requestedDateTime(Instant requestedDateTime)` The date and time the command was requested.
`Command.Builder`	`serviceRole(String serviceRole)` The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes.
`Command.Builder`	`status(CommandStatus status)` The status of the command.
`Command.Builder`	`status(String status)` The status of the command.
`Command.Builder`	`statusDetails(String statusDetails)` A detailed status of the command execution.
`Command.Builder`	`targetCount(Integer targetCount)` The number of targets for the command.
`Command.Builder`	`targets(Collection<Target> targets)` An array of search criteria that targets instances using a Key,Value combination that you specify.
`Command.Builder`	`targets(Consumer<Target.Builder>... targets)` An array of search criteria that targets instances using a Key,Value combination that you specify.
`Command.Builder`	`targets(Target... targets)` An array of search criteria that targets instances using a Key,Value combination that you specify.
`Command.Builder`	`timeoutSeconds(Integer timeoutSeconds)` The `TimeoutSeconds` value specified for a command.

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
  - commandId
```
Command.Builder commandId(String commandId)
```
    A unique identifier for this command.
    
    Parameters:
    
    commandId - A unique identifier for this command.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - documentName
```
Command.Builder documentName(String documentName)
```
    The name of the document requested for execution.
    
    Parameters:
    
    documentName - The name of the document requested for execution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - documentVersion
```
Command.Builder documentVersion(String documentVersion)
```
    The SSM document version.
    
    Parameters:
    
    documentVersion - The SSM document version.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - comment
```
Command.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.
  - expiresAfter
```
Command.Builder expiresAfter(Instant expiresAfter)
```
    If this time is reached and the command has not already started running, it will not run. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.
    
    Parameters:
    
    expiresAfter - If this time is reached and the command has not already started running, it will not run. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - parameters
```
Command.Builder parameters(Map<String,? extends Collection<String>> parameters)
```
    The parameter values to be inserted in the document when running the command.
    
    Parameters:
    
    parameters - The parameter values to be inserted in the document when running the command.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - instanceIds
```
Command.Builder instanceIds(Collection<String> instanceIds)
```
    The instance IDs against which this command was requested.
    
    Parameters:
    
    instanceIds - The instance IDs against which this command was requested.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - instanceIds
```
Command.Builder instanceIds(String... instanceIds)
```
    The instance IDs against which this command was requested.
    
    Parameters:
    
    instanceIds - The instance IDs against which this command was requested.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - targets
```
Command.Builder targets(Collection<Target> targets)
```
    An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call.
    
    Parameters:
    
    targets - An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - targets
```
Command.Builder targets(Target... targets)
```
    An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call.
    
    Parameters:
    
    targets - An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - targets
```
Command.Builder targets(Consumer<Target.Builder>... targets)
```
    An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call.
    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)
  - requestedDateTime
```
Command.Builder requestedDateTime(Instant requestedDateTime)
```
    The date and time the command was requested.
    
    Parameters:
    
    requestedDateTime - The date and time the command was requested.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - status
```
Command.Builder status(String status)
```
    The status of the command.
    
    Parameters:
    
    status - The status of the command.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CommandStatus, CommandStatus
  - status
```
Command.Builder status(CommandStatus status)
```
    The status of the command.
    
    Parameters:
    
    status - The status of the command.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CommandStatus, CommandStatus
  - statusDetails
```
Command.Builder statusDetails(String statusDetails)
```
    A detailed status of the command execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values:
    - Pending: The command has not been sent to any instances.
    - In Progress: The command has been sent to at least one instance but has not reached a final state on all instances.
    - Success: The command successfully ran on all invocations. This is a terminal state.
    - Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.
    - Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.
    - Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.
    - Incomplete: The command was attempted on all instances and one or more invocations does not have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.
    - Canceled: The command was terminated before it was completed. This is a terminal state.
    - Rate Exceeded: The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any instance. This is a terminal state.
    Parameters:
    statusDetails - A detailed status of the command execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values:
    
    Pending: The command has not been sent to any instances.
    
    In Progress: The command has been sent to at least one instance but has not reached a final state on all instances.
    
    Success: The command successfully ran on all invocations. This is a terminal state.
    
    Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.
    
    Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.
    
    Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.
    
    Incomplete: The command was attempted on all instances and one or more invocations does not have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.
    
    Canceled: The command was terminated before it was completed. This is a terminal state.
    
    Rate Exceeded: The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any instance. This is a terminal state.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - outputS3Region
```
Command.Builder outputS3Region(String outputS3Region)
```
    (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the 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 Region of the S3 bucket.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - outputS3BucketName
```
Command.Builder outputS3BucketName(String outputS3BucketName)
```
    The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.
    
    Parameters:
    
    outputS3BucketName - The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - outputS3KeyPrefix
```
Command.Builder outputS3KeyPrefix(String outputS3KeyPrefix)
```
    The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.
    
    Parameters:
    
    outputS3KeyPrefix - The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - maxConcurrency
```
Command.Builder maxConcurrency(String maxConcurrency)
```
    The maximum number of instances that are allowed to run the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Running commands using Systems Manager Run Command in the AWS Systems Manager User Guide.
    
    Parameters:
    
    maxConcurrency - The maximum number of instances that are allowed to run the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Running commands using Systems Manager Run Command in the AWS Systems Manager User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - maxErrors
```
Command.Builder maxErrors(String maxErrors)
```
    The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 0. For more information about how to use MaxErrors, see Running commands using Systems Manager Run Command in the AWS Systems Manager User Guide.
    
    Parameters:
    
    maxErrors - The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 0. For more information about how to use MaxErrors, see Running commands using Systems Manager Run Command in the AWS Systems Manager User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - targetCount
```
Command.Builder targetCount(Integer targetCount)
```
    The number of targets for the command.
    
    Parameters:
    
    targetCount - The number of targets for the command.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - completedCount
```
Command.Builder completedCount(Integer completedCount)
```
    The number of targets for which the command invocation reached a terminal state. Terminal states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Canceled, Terminated, or Undeliverable.
    
    Parameters:
    
    completedCount - The number of targets for which the command invocation reached a terminal state. Terminal states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Canceled, Terminated, or Undeliverable.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - errorCount
```
Command.Builder errorCount(Integer errorCount)
```
    The number of targets for which the status is Failed or Execution Timed Out.
    
    Parameters:
    
    errorCount - The number of targets for which the status is Failed or Execution Timed Out.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - deliveryTimedOutCount
```
Command.Builder deliveryTimedOutCount(Integer deliveryTimedOutCount)
```
    The number of targets for which the status is Delivery Timed Out.
    
    Parameters:
    
    deliveryTimedOutCount - The number of targets for which the status is Delivery Timed Out.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - serviceRole
```
Command.Builder serviceRole(String serviceRole)
```
    The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes.
    
    Parameters:
    
    serviceRole - The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - notificationConfig
```
Command.Builder notificationConfig(NotificationConfig notificationConfig)
```
    Configurations for sending notifications about command status changes.
    
    Parameters:
    
    notificationConfig - Configurations for sending notifications about command status changes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - notificationConfig
```
default Command.Builder notificationConfig(Consumer<NotificationConfig.Builder> notificationConfig)
```
    Configurations for sending notifications about command status changes.
    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
```
Command.Builder cloudWatchOutputConfig(CloudWatchOutputConfig cloudWatchOutputConfig)
```
    CloudWatch Logs information where you want Systems Manager to send the command output.
    
    Parameters:
    
    cloudWatchOutputConfig - CloudWatch Logs information where you want Systems Manager to send the command output.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - cloudWatchOutputConfig
```
default Command.Builder cloudWatchOutputConfig(Consumer<CloudWatchOutputConfig.Builder> cloudWatchOutputConfig)
```
    CloudWatch Logs information where you want Systems Manager to send the command output.
    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)
  - timeoutSeconds
```
Command.Builder timeoutSeconds(Integer timeoutSeconds)
```
    The TimeoutSeconds value specified for a command.
    
    Parameters:
    
    timeoutSeconds - The TimeoutSeconds value specified for a command.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.

Interface Command.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Method Detail

commandId

documentName

documentVersion

comment

expiresAfter

parameters

instanceIds

instanceIds

targets

targets

targets

requestedDateTime

status

status

statusDetails

outputS3Region

outputS3BucketName

outputS3KeyPrefix

maxConcurrency

maxErrors

targetCount

completedCount

errorCount

deliveryTimedOutCount

serviceRole

notificationConfig

notificationConfig

cloudWatchOutputConfig

cloudWatchOutputConfig

timeoutSeconds