Interface CommandInvocation.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<CommandInvocation.Builder,
,CommandInvocation> SdkBuilder<CommandInvocation.Builder,
,CommandInvocation> SdkPojo
- Enclosing class:
CommandInvocation
-
Method Summary
Modifier and TypeMethodDescriptiondefault CommandInvocation.Builder
cloudWatchOutputConfig
(Consumer<CloudWatchOutputConfig.Builder> cloudWatchOutputConfig) Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.cloudWatchOutputConfig
(CloudWatchOutputConfig cloudWatchOutputConfig) Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.The command against which this invocation was requested.commandPlugins
(Collection<CommandPlugin> commandPlugins) Plugins processed by the command.commandPlugins
(Consumer<CommandPlugin.Builder>... commandPlugins) Plugins processed by the command.commandPlugins
(CommandPlugin... commandPlugins) Plugins processed by the command.User-specified information about the command, such as a brief description of what the command should do.documentName
(String documentName) The document name that was requested for execution.documentVersion
(String documentVersion) The Systems Manager document (SSM document) version.instanceId
(String instanceId) The managed node ID in which this invocation was requested.instanceName
(String instanceName) The fully qualified host name of the managed node.default CommandInvocation.Builder
notificationConfig
(Consumer<NotificationConfig.Builder> notificationConfig) Configurations for sending notifications about command status changes on a per managed node basis.notificationConfig
(NotificationConfig notificationConfig) Configurations for sending notifications about command status changes on a per managed node basis.requestedDateTime
(Instant requestedDateTime) The time and date the request was sent to this managed node.serviceRole
(String serviceRole) The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes on a per managed node basis.standardErrorUrl
(String standardErrorUrl) The URL to the plugin's StdErr file in Amazon Simple Storage Service (Amazon S3), if the S3 bucket was defined for the parent command.standardOutputUrl
(String standardOutputUrl) The URL to the plugin's StdOut file in Amazon Simple Storage Service (Amazon S3), if the S3 bucket was defined for the parent command.Whether or not the invocation succeeded, failed, or is pending.status
(CommandInvocationStatus status) Whether or not the invocation succeeded, failed, or is pending.statusDetails
(String statusDetails) A detailed status of the command execution for each invocation (each managed node targeted by the command).traceOutput
(String traceOutput) Gets the trace output sent by the agent.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
-
Method Details
-
commandId
The command against which this invocation was requested.
- Parameters:
commandId
- The command against which this invocation was requested.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instanceId
The managed node ID in which this invocation was requested.
- Parameters:
instanceId
- The managed node ID in which this invocation was requested.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instanceName
The fully qualified host name of the managed node.
- Parameters:
instanceName
- The fully qualified host name of the managed node.- 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.
-
documentName
The document name that was requested for execution.
- Parameters:
documentName
- The document name that was requested for execution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
documentVersion
The Systems Manager document (SSM document) version.
- Parameters:
documentVersion
- The Systems Manager document (SSM document) version.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
requestedDateTime
The time and date the request was sent to this managed node.
- Parameters:
requestedDateTime
- The time and date the request was sent to this managed node.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
Whether or not the invocation succeeded, failed, or is pending.
- Parameters:
status
- Whether or not the invocation succeeded, failed, or is pending.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
Whether or not the invocation succeeded, failed, or is pending.
- Parameters:
status
- Whether or not the invocation succeeded, failed, or is pending.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
statusDetails
A detailed status of the command execution for each invocation (each managed node targeted by the command). 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 Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the following values:
-
Pending: The command hasn't been sent to the managed node.
-
In Progress: The command has been sent to the managed node but hasn't reached a terminal state.
-
Success: The execution of the command or plugin was successfully completed. This is a terminal state.
-
Delivery Timed Out: The command wasn't delivered to the managed node before the delivery timeout expired. Delivery timeouts don't count against the parent command's
MaxErrors
limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state. -
Execution Timed Out: Command execution started on the managed node, but the execution wasn't complete before the execution timeout expired. Execution timeouts count against the
MaxErrors
limit of the parent command. This is a terminal state. -
Failed: The command wasn't successful on the managed node. For a plugin, this indicates that the result code wasn't zero. For a command invocation, this indicates that the result code for one or more plugins wasn't zero. Invocation failures count against the
MaxErrors
limit of the parent command. This is a terminal state. -
Cancelled: The command was terminated before it was completed. This is a terminal state.
-
Undeliverable: The command can't be delivered to the managed node. The managed node might not exist or might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
-
Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.
-
Delayed: The system attempted to send the command to the managed node but wasn't successful. The system retries again.
- Parameters:
statusDetails
- A detailed status of the command execution for each invocation (each managed node targeted by the command). 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 Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the following values:-
Pending: The command hasn't been sent to the managed node.
-
In Progress: The command has been sent to the managed node but hasn't reached a terminal state.
-
Success: The execution of the command or plugin was successfully completed. This is a terminal state.
-
Delivery Timed Out: The command wasn't delivered to the managed node before the delivery timeout expired. Delivery timeouts don't count against the parent command's
MaxErrors
limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state. -
Execution Timed Out: Command execution started on the managed node, but the execution wasn't complete before the execution timeout expired. Execution timeouts count against the
MaxErrors
limit of the parent command. This is a terminal state. -
Failed: The command wasn't successful on the managed node. For a plugin, this indicates that the result code wasn't zero. For a command invocation, this indicates that the result code for one or more plugins wasn't zero. Invocation failures count against the
MaxErrors
limit of the parent command. This is a terminal state. -
Cancelled: The command was terminated before it was completed. This is a terminal state.
-
Undeliverable: The command can't be delivered to the managed node. The managed node might not exist or might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
-
Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.
-
Delayed: The system attempted to send the command to the managed node but wasn't successful. The system retries again.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
traceOutput
Gets the trace output sent by the agent.
- Parameters:
traceOutput
- Gets the trace output sent by the agent.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
standardOutputUrl
The URL to the plugin's StdOut file in Amazon Simple Storage Service (Amazon S3), if the S3 bucket was defined for the parent command. For an invocation,
StandardOutputUrl
is populated if there is just one plugin defined for the command, and the S3 bucket was defined for the command.- Parameters:
standardOutputUrl
- The URL to the plugin's StdOut file in Amazon Simple Storage Service (Amazon S3), if the S3 bucket was defined for the parent command. For an invocation,StandardOutputUrl
is populated if there is just one plugin defined for the command, and the S3 bucket was defined for the command.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
standardErrorUrl
The URL to the plugin's StdErr file in Amazon Simple Storage Service (Amazon S3), if the S3 bucket was defined for the parent command. For an invocation,
StandardErrorUrl
is populated if there is just one plugin defined for the command, and the S3 bucket was defined for the command.- Parameters:
standardErrorUrl
- The URL to the plugin's StdErr file in Amazon Simple Storage Service (Amazon S3), if the S3 bucket was defined for the parent command. For an invocation,StandardErrorUrl
is populated if there is just one plugin defined for the command, and the S3 bucket was defined for the command.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
commandPlugins
Plugins processed by the command.
- Parameters:
commandPlugins
- Plugins processed by the command.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
commandPlugins
Plugins processed by the command.
- Parameters:
commandPlugins
- Plugins processed by the command.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
commandPlugins
Plugins processed by the command.
This is a convenience method that creates an instance of theCommandPlugin.Builder
avoiding the need to create one manually viaCommandPlugin.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocommandPlugins(List<CommandPlugin>)
.- Parameters:
commandPlugins
- a consumer that will call methods onCommandPlugin.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
serviceRole
The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes on a per managed node basis.
- Parameters:
serviceRole
- The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes on a per managed node basis.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
notificationConfig
Configurations for sending notifications about command status changes on a per managed node basis.
- Parameters:
notificationConfig
- Configurations for sending notifications about command status changes on a per managed node basis.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
notificationConfig
default CommandInvocation.Builder notificationConfig(Consumer<NotificationConfig.Builder> notificationConfig) Configurations for sending notifications about command status changes on a per managed node basis.
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
Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.
- Parameters:
cloudWatchOutputConfig
- Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cloudWatchOutputConfig
default CommandInvocation.Builder cloudWatchOutputConfig(Consumer<CloudWatchOutputConfig.Builder> cloudWatchOutputConfig) Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.
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:
-