Struct aws_sdk_ssm::types::builders::CommandPluginBuilder

#[non_exhaustive]
pub struct CommandPluginBuilder { /* private fields */ }

A builder for CommandPlugin.

Implementations

impl CommandPluginBuilder

pub fn name(self, input: impl Into<String>) -> Self

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.

pub fn set_name(self, input: Option<String>) -> Self

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.

pub fn get_name(&self) -> &Option<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.

pub fn status(self, input: CommandPluginStatus) -> Self

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

pub fn set_status(self, input: Option<CommandPluginStatus>) -> Self

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

pub fn get_status(&self) -> &Option<CommandPluginStatus>

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

pub fn status_details(self, input: impl Into<String>) -> Self

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.

pub fn set_status_details(self, input: Option<String>) -> Self

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.

pub fn get_status_details(&self) -> &Option<String>

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.

pub fn response_code(self, input: i32) -> Self

A numeric response code generated after running the plugin.

pub fn set_response_code(self, input: Option<i32>) -> Self

A numeric response code generated after running the plugin.

pub fn get_response_code(&self) -> &Option<i32>

A numeric response code generated after running the plugin.

pub fn response_start_date_time(self, input: DateTime) -> Self

The time the plugin started running.

pub fn set_response_start_date_time(self, input: Option<DateTime>) -> Self

The time the plugin started running.

pub fn get_response_start_date_time(&self) -> &Option<DateTime>

The time the plugin started running.

pub fn response_finish_date_time(self, input: DateTime) -> Self

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

pub fn set_response_finish_date_time(self, input: Option<DateTime>) -> Self

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

pub fn get_response_finish_date_time(&self) -> &Option<DateTime>

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

pub fn output(self, input: impl Into<String>) -> Self

Output of the plugin execution.

pub fn set_output(self, input: Option<String>) -> Self

Output of the plugin execution.

pub fn get_output(&self) -> &Option<String>

Output of the plugin execution.

pub fn standard_output_url(self, input: impl Into<String>) -> Self

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.

pub fn set_standard_output_url(self, input: Option<String>) -> Self

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.

pub fn get_standard_output_url(&self) -> &Option<String>

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.

pub fn standard_error_url(self, input: impl Into<String>) -> Self

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

pub fn set_standard_error_url(self, input: Option<String>) -> Self

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

pub fn get_standard_error_url(&self) -> &Option<String>

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

pub fn output_s3_region(self, input: impl Into<String>) -> Self

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

pub fn set_output_s3_region(self, input: Option<String>) -> Self

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

pub fn get_output_s3_region(&self) -> &Option<String>

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

pub fn output_s3_bucket_name(self, input: impl Into<String>) -> Self

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.

pub fn set_output_s3_bucket_name(self, input: Option<String>) -> Self

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.

pub fn get_output_s3_bucket_name(&self) -> &Option<String>

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.

pub fn output_s3_key_prefix(self, input: impl Into<String>) -> Self

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.

pub fn set_output_s3_key_prefix(self, input: Option<String>) -> Self

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.

pub fn get_output_s3_key_prefix(&self) -> &Option<String>

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.

pub fn build(self) -> CommandPlugin

Consumes the builder and constructs a CommandPlugin.

Trait Implementations

impl Clone for CommandPluginBuilder

fn clone(&self) -> CommandPluginBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CommandPluginBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CommandPluginBuilder

fn default() -> CommandPluginBuilder

Returns the “default value” for a type.

impl PartialEq for CommandPluginBuilder

fn eq(&self, other: &CommandPluginBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CommandPluginBuilder