public static interface CommandInvocation.Builder extends CopyableBuilder<CommandInvocation.Builder,CommandInvocation>
Modifier and Type | Method and Description |
---|---|
CommandInvocation.Builder |
commandId(String commandId)
The command against which this invocation was requested.
|
CommandInvocation.Builder |
commandPlugins(Collection<CommandPlugin> commandPlugins)
Sets the value of the CommandPlugins property for this object.
|
CommandInvocation.Builder |
commandPlugins(CommandPlugin... commandPlugins)
Sets the value of the CommandPlugins property for this object.
|
CommandInvocation.Builder |
comment(String comment)
User-specified information about the command, such as a brief description of what the command should do.
|
CommandInvocation.Builder |
documentName(String documentName)
The document name that was requested for execution.
|
CommandInvocation.Builder |
instanceId(String instanceId)
The instance ID in which this invocation was requested.
|
CommandInvocation.Builder |
instanceName(String instanceName)
The name of the invocation target.
|
default CommandInvocation.Builder |
notificationConfig(Consumer<NotificationConfig.Builder> notificationConfig)
Configurations for sending notifications about command status changes on a per instance basis.
|
CommandInvocation.Builder |
notificationConfig(NotificationConfig notificationConfig)
Configurations for sending notifications about command status changes on a per instance basis.
|
CommandInvocation.Builder |
requestedDateTime(Instant requestedDateTime)
The time and date the request was sent to this instance.
|
CommandInvocation.Builder |
serviceRole(String serviceRole)
The IAM service role that Run Command uses to act on your behalf when sending notifications about command
status changes on a per instance basis.
|
CommandInvocation.Builder |
standardErrorUrl(String standardErrorUrl)
The URL to the plugin's StdErr file in Amazon S3, if the Amazon S3 bucket was defined for the parent command.
|
CommandInvocation.Builder |
standardOutputUrl(String standardOutputUrl)
The URL to the plugin's StdOut file in Amazon S3, if the Amazon S3 bucket was defined for the parent command.
|
CommandInvocation.Builder |
status(CommandInvocationStatus status)
Whether or not the invocation succeeded, failed, or is pending.
|
CommandInvocation.Builder |
status(String status)
Whether or not the invocation succeeded, failed, or is pending.
|
CommandInvocation.Builder |
statusDetails(String statusDetails)
A detailed status of the command execution for each invocation (each instance targeted by the command).
|
CommandInvocation.Builder |
traceOutput(String traceOutput)
Gets the trace output sent by the agent.
|
copy
apply, build
CommandInvocation.Builder commandId(String commandId)
The command against which this invocation was requested.
commandId
- The command against which this invocation was requested.CommandInvocation.Builder instanceId(String instanceId)
The instance ID in which this invocation was requested.
instanceId
- The instance ID in which this invocation was requested.CommandInvocation.Builder instanceName(String instanceName)
The name of the invocation target. For Amazon EC2 instances this is the value for the aws:Name tag. For on-premises instances, this is the name of the instance.
instanceName
- The name of the invocation target. For Amazon EC2 instances this is the value for the aws:Name tag.
For on-premises instances, this is the name of the instance.CommandInvocation.Builder comment(String comment)
User-specified information about the command, such as a brief description of what the command should do.
comment
- User-specified information about the command, such as a brief description of what the command should
do.CommandInvocation.Builder documentName(String documentName)
The document name that was requested for execution.
documentName
- The document name that was requested for execution.CommandInvocation.Builder requestedDateTime(Instant requestedDateTime)
The time and date the request was sent to this instance.
requestedDateTime
- The time and date the request was sent to this instance.CommandInvocation.Builder status(String status)
Whether or not the invocation succeeded, failed, or is pending.
status
- Whether or not the invocation succeeded, failed, or is pending.CommandInvocationStatus
,
CommandInvocationStatus
CommandInvocation.Builder status(CommandInvocationStatus status)
Whether or not the invocation succeeded, failed, or is pending.
status
- Whether or not the invocation succeeded, failed, or is pending.CommandInvocationStatus
,
CommandInvocationStatus
CommandInvocation.Builder statusDetails(String statusDetails)
A detailed status of the command execution for each invocation (each instance 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 Run Command Status. StatusDetails can be one of the following values:
Pending: The command has not been sent to the instance.
In Progress: The command has been sent to the instance but has not 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 was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not 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 instance, but the execution was not 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 was not successful on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.
Canceled: The command was terminated before it was completed. This is a terminal state.
Undeliverable: The command can't be delivered to the instance. The instance 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.
statusDetails
- A detailed status of the command execution for each invocation (each instance 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 Run
Command Status. StatusDetails can be one of the following values:
Pending: The command has not been sent to the instance.
In Progress: The command has been sent to the instance but has not 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 was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not 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 instance, but the execution was not 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 was not successful on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.
Canceled: The command was terminated before it was completed. This is a terminal state.
Undeliverable: The command can't be delivered to the instance. The instance 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.
CommandInvocation.Builder traceOutput(String traceOutput)
Gets the trace output sent by the agent.
traceOutput
- Gets the trace output sent by the agent.CommandInvocation.Builder standardOutputUrl(String standardOutputUrl)
The URL to the plugin's StdOut file in Amazon S3, if the Amazon 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 Amazon S3 bucket was defined for the command.
standardOutputUrl
- The URL to the plugin's StdOut file in Amazon S3, if the Amazon 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 Amazon S3 bucket was defined for the command.CommandInvocation.Builder standardErrorUrl(String standardErrorUrl)
The URL to the plugin's StdErr file in Amazon S3, if the Amazon 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 Amazon S3 bucket was defined for the command.
standardErrorUrl
- The URL to the plugin's StdErr file in Amazon S3, if the Amazon 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 Amazon S3 bucket was defined for the command.CommandInvocation.Builder commandPlugins(Collection<CommandPlugin> commandPlugins)
commandPlugins
- The new value for the CommandPlugins property for this object.CommandInvocation.Builder commandPlugins(CommandPlugin... commandPlugins)
commandPlugins
- The new value for the CommandPlugins property for this object.CommandInvocation.Builder serviceRole(String serviceRole)
The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes on a per instance basis.
serviceRole
- The IAM service role that Run Command uses to act on your behalf when sending notifications about
command status changes on a per instance basis.CommandInvocation.Builder notificationConfig(NotificationConfig notificationConfig)
Configurations for sending notifications about command status changes on a per instance basis.
notificationConfig
- Configurations for sending notifications about command status changes on a per instance basis.default CommandInvocation.Builder notificationConfig(Consumer<NotificationConfig.Builder> notificationConfig)
Configurations for sending notifications about command status changes on a per instance basis.
This is a convenience that creates an instance of theNotificationConfig.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)
.notificationConfig
- a consumer that will call methods on NotificationConfig.Builder
notificationConfig(NotificationConfig)
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.