com.amazonaws.services.simplesystemsmanagement.model

Class CommandPlugin

java.lang.Object

com.amazonaws.services.simplesystemsmanagement.model.CommandPlugin

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CommandPlugin
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes plugin details.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
CommandPlugin()

Method Summary

Modifier and Type	Method and Description
CommandPlugin	clone()
boolean	equals(Object obj)
String	getName() The name of the plugin.
String	getOutput() Output of the plugin execution.
String	getOutputS3BucketName() The S3 bucket where the responses to the command executions should be stored.
String	getOutputS3KeyPrefix() The S3 directory path inside the bucket where the responses to the command executions should be stored.
String	getOutputS3Region() (Deprecated) You can no longer specify this parameter.
Integer	getResponseCode() A numeric response code generated after running the plugin.
Date	getResponseFinishDateTime() The time the plugin stopped running.
Date	getResponseStartDateTime() The time the plugin started running.
String	getStandardErrorUrl() The URL for the complete text written by the plugin to stderr.
String	getStandardOutputUrl() The URL for the complete text written by the plugin to stdout in Amazon S3.
String	getStatus() The status of this plugin.
String	getStatusDetails() A detailed status of the plugin execution.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setName(String name) The name of the plugin.
void	setOutput(String output) Output of the plugin execution.
void	setOutputS3BucketName(String outputS3BucketName) The S3 bucket where the responses to the command executions should be stored.
void	setOutputS3KeyPrefix(String outputS3KeyPrefix) The S3 directory path inside the bucket where the responses to the command executions should be stored.
void	setOutputS3Region(String outputS3Region) (Deprecated) You can no longer specify this parameter.
void	setResponseCode(Integer responseCode) A numeric response code generated after running the plugin.
void	setResponseFinishDateTime(Date responseFinishDateTime) The time the plugin stopped running.
void	setResponseStartDateTime(Date responseStartDateTime) The time the plugin started running.
void	setStandardErrorUrl(String standardErrorUrl) The URL for the complete text written by the plugin to stderr.
void	setStandardOutputUrl(String standardOutputUrl) The URL for the complete text written by the plugin to stdout in Amazon S3.
void	setStatus(CommandPluginStatus status) The status of this plugin.
void	setStatus(String status) The status of this plugin.
void	setStatusDetails(String statusDetails) A detailed status of the plugin execution.
String	toString() Returns a string representation of this object.
CommandPlugin	withName(String name) The name of the plugin.
CommandPlugin	withOutput(String output) Output of the plugin execution.
CommandPlugin	withOutputS3BucketName(String outputS3BucketName) The S3 bucket where the responses to the command executions should be stored.
CommandPlugin	withOutputS3KeyPrefix(String outputS3KeyPrefix) The S3 directory path inside the bucket where the responses to the command executions should be stored.
CommandPlugin	withOutputS3Region(String outputS3Region) (Deprecated) You can no longer specify this parameter.
CommandPlugin	withResponseCode(Integer responseCode) A numeric response code generated after running the plugin.
CommandPlugin	withResponseFinishDateTime(Date responseFinishDateTime) The time the plugin stopped running.
CommandPlugin	withResponseStartDateTime(Date responseStartDateTime) The time the plugin started running.
CommandPlugin	withStandardErrorUrl(String standardErrorUrl) The URL for the complete text written by the plugin to stderr.
CommandPlugin	withStandardOutputUrl(String standardOutputUrl) The URL for the complete text written by the plugin to stdout in Amazon S3.
CommandPlugin	withStatus(CommandPluginStatus status) The status of this plugin.
CommandPlugin	withStatus(String status) The status of this plugin.
CommandPlugin	withStatusDetails(String statusDetails) A detailed status of the plugin execution.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CommandPlugin

public CommandPlugin()

Method Detail

setName

public void setName(String name)

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.

Parameters:

name - 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.

getName

public String getName()

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.

Returns:

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.

withName

public CommandPlugin withName(String name)

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.

Parameters:

name - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStatus

public void setStatus(String status)

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

Parameters:

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

See Also:

CommandPluginStatus

getStatus

public String getStatus()

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

Returns:

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

See Also:

CommandPluginStatus

withStatus

public CommandPlugin withStatus(String status)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CommandPluginStatus

setStatus

public void setStatus(CommandPluginStatus status)

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

Parameters:

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

See Also:

CommandPluginStatus

withStatus

public CommandPlugin withStatus(CommandPluginStatus status)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CommandPluginStatus

setStatusDetails

public void setStatusDetails(String statusDetails)

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:

• 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 it might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit, and they 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.

Parameters:

statusDetails - 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:

• 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 it might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit, and they 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.

getStatusDetails

public String getStatusDetails()

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:

• 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 it might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit, and they 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.

Returns:

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:

• 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 it might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit, and they 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.

withStatusDetails

public CommandPlugin withStatusDetails(String statusDetails)

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:

• 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 it might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit, and they 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.

Parameters:

statusDetails - 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:

• 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 it might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit, and they 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setResponseCode

public void setResponseCode(Integer responseCode)

A numeric response code generated after running the plugin.

Parameters:

responseCode - A numeric response code generated after running the plugin.

getResponseCode

public Integer getResponseCode()

A numeric response code generated after running the plugin.

Returns:

A numeric response code generated after running the plugin.

withResponseCode

public CommandPlugin withResponseCode(Integer responseCode)

A numeric response code generated after running the plugin.

Parameters:

responseCode - A numeric response code generated after running the plugin.

Returns:

Returns a reference to this object so that method calls can be chained together.

setResponseStartDateTime

public void setResponseStartDateTime(Date responseStartDateTime)

The time the plugin started running.

Parameters:

responseStartDateTime - The time the plugin started running.

getResponseStartDateTime

public Date getResponseStartDateTime()

The time the plugin started running.

Returns:

The time the plugin started running.

withResponseStartDateTime

public CommandPlugin withResponseStartDateTime(Date responseStartDateTime)

The time the plugin started running.

Parameters:

responseStartDateTime - The time the plugin started running.

Returns:

Returns a reference to this object so that method calls can be chained together.

setResponseFinishDateTime

public void setResponseFinishDateTime(Date responseFinishDateTime)

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

Parameters:

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

getResponseFinishDateTime

public Date getResponseFinishDateTime()

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

Returns:

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

withResponseFinishDateTime

public CommandPlugin withResponseFinishDateTime(Date responseFinishDateTime)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setOutput

public void setOutput(String output)

Output of the plugin execution.

Parameters:

output - Output of the plugin execution.

getOutput

public String getOutput()

Output of the plugin execution.

Returns:

Output of the plugin execution.

withOutput

public CommandPlugin withOutput(String output)

Output of the plugin execution.

Parameters:

output - Output of the plugin execution.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStandardOutputUrl

public void setStandardOutputUrl(String standardOutputUrl)

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.

Parameters:

standardOutputUrl - 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.

getStandardOutputUrl

public String getStandardOutputUrl()

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.

Returns:

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.

withStandardOutputUrl

public CommandPlugin withStandardOutputUrl(String standardOutputUrl)

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.

Parameters:

standardOutputUrl - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStandardErrorUrl

public void setStandardErrorUrl(String standardErrorUrl)

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

Parameters:

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

getStandardErrorUrl

public String getStandardErrorUrl()

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

Returns:

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

withStandardErrorUrl

public CommandPlugin withStandardErrorUrl(String standardErrorUrl)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setOutputS3Region

public void setOutputS3Region(String outputS3Region)

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

Parameters:

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

getOutputS3Region

public String getOutputS3Region()

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

Returns:

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

withOutputS3Region

public CommandPlugin withOutputS3Region(String outputS3Region)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setOutputS3BucketName

public void setOutputS3BucketName(String outputS3BucketName)

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:

doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript

doc-example-bucket is the name of the S3 bucket;

ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;

i-02573cafcfEXAMPLE is the managed node ID;

awsrunShellScript is the name of the plugin.

Parameters:

outputS3BucketName - 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:

doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript

doc-example-bucket is the name of the S3 bucket;

ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;

i-02573cafcfEXAMPLE is the managed node ID;

awsrunShellScript is the name of the plugin.

getOutputS3BucketName

public String getOutputS3BucketName()

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:

doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript

doc-example-bucket is the name of the S3 bucket;

ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;

i-02573cafcfEXAMPLE is the managed node ID;

awsrunShellScript is the name of the plugin.

Returns:

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:

doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript

doc-example-bucket is the name of the S3 bucket;

ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;

i-02573cafcfEXAMPLE is the managed node ID;

awsrunShellScript is the name of the plugin.

withOutputS3BucketName

public CommandPlugin withOutputS3BucketName(String outputS3BucketName)

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:

doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript

doc-example-bucket is the name of the S3 bucket;

ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;

i-02573cafcfEXAMPLE is the managed node ID;

awsrunShellScript is the name of the plugin.

Parameters:

outputS3BucketName - 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:

doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript

doc-example-bucket is the name of the S3 bucket;

ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;

i-02573cafcfEXAMPLE is the managed node ID;

awsrunShellScript is the name of the plugin.

Returns:

Returns a reference to this object so that method calls can be chained together.

setOutputS3KeyPrefix

public void setOutputS3KeyPrefix(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. For example, in the following response:

doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript

doc-example-bucket is the name of the S3 bucket;

ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;

i-02573cafcfEXAMPLE is the managed node ID;

awsrunShellScript is the name of the plugin.

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. For example, in the following response:

doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript

doc-example-bucket is the name of the S3 bucket;

ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;

i-02573cafcfEXAMPLE is the managed node ID;

awsrunShellScript is the name of the plugin.

getOutputS3KeyPrefix

public String getOutputS3KeyPrefix()

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:

doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript

doc-example-bucket is the name of the S3 bucket;

ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;

i-02573cafcfEXAMPLE is the managed node ID;

awsrunShellScript is the name of the plugin.

Returns:

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:

doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript

doc-example-bucket is the name of the S3 bucket;

ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;

i-02573cafcfEXAMPLE is the managed node ID;

awsrunShellScript is the name of the plugin.

withOutputS3KeyPrefix

public CommandPlugin withOutputS3KeyPrefix(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. For example, in the following response:

doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript

doc-example-bucket is the name of the S3 bucket;

ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;

i-02573cafcfEXAMPLE is the managed node ID;

awsrunShellScript is the name of the plugin.

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. For example, in the following response:

doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript

doc-example-bucket is the name of the S3 bucket;

ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;

i-02573cafcfEXAMPLE is the managed node ID;

awsrunShellScript is the name of the plugin.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CommandPlugin clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.