CommandPlugin

Describes plugin details.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val name: String?

The name of the plugin. Must be one of the following: aws:updateAgent, aws:domainjoin, aws:applications, aws:runPowerShellScript, aws:psmodule, aws:cloudWatch, aws:runShellScript, or aws:updateSSMAgent.

Link copied to clipboard

Output of the plugin execution.

Link copied to clipboard

The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response:

Link copied to clipboard

The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response:

Link copied to clipboard

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

Link copied to clipboard

A numeric response code generated after running the plugin.

Link copied to clipboard

The time the plugin stopped running. Could stop prematurely if, for example, a cancel command was sent.

Link copied to clipboard

The time the plugin started running.

Link copied to clipboard

The URL for the complete text written by the plugin to stderr. If execution isn't yet complete, then this string is empty.

Link copied to clipboard

The URL for the complete text written by the plugin to stdout in Amazon S3. If the S3 bucket for the command wasn't specified, then this string is empty.

Link copied to clipboard

The status of this plugin. You can run a document with multiple plugins.

Link copied to clipboard

A detailed status of the plugin 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 Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the following values:

Functions

Link copied to clipboard
inline fun copy(block: CommandPlugin.Builder.() -> Unit = {}): CommandPlugin
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String