Struct aws_sdk_ssm::types::builders::CommandBuilder

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

A builder for Command.

Implementations

impl CommandBuilder

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

A unique identifier for this command.

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

A unique identifier for this command.

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

A unique identifier for this command.

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

The name of the document requested for execution.

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

The name of the document requested for execution.

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

The name of the document requested for execution.

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

The Systems Manager document (SSM document) version.

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

The Systems Manager document (SSM document) version.

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

The Systems Manager document (SSM document) version.

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

User-specified information about the command, such as a brief description of what the command should do.

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

User-specified information about the command, such as a brief description of what the command should do.

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

User-specified information about the command, such as a brief description of what the command should do.

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

If a command expires, it changes status to DeliveryTimedOut for all invocations that have the status InProgress, Pending, or Delayed. ExpiresAfter is calculated based on the total timeout for the overall command. For more information, see Understanding command timeout values in the Amazon Web Services Systems Manager User Guide.

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

If a command expires, it changes status to DeliveryTimedOut for all invocations that have the status InProgress, Pending, or Delayed. ExpiresAfter is calculated based on the total timeout for the overall command. For more information, see Understanding command timeout values in the Amazon Web Services Systems Manager User Guide.

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

If a command expires, it changes status to DeliveryTimedOut for all invocations that have the status InProgress, Pending, or Delayed. ExpiresAfter is calculated based on the total timeout for the overall command. For more information, see Understanding command timeout values in the Amazon Web Services Systems Manager User Guide.

pub fn parameters(self, k: impl Into<String>, v: Vec<String>) -> Self

Adds a key-value pair to parameters.

To override the contents of this collection use set_parameters.

The parameter values to be inserted in the document when running the command.

pub fn set_parameters(self, input: Option<HashMap<String, Vec<String>>>) -> Self

The parameter values to be inserted in the document when running the command.

pub fn get_parameters(&self) -> &Option<HashMap<String, Vec<String>>>

The parameter values to be inserted in the document when running the command.

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

Appends an item to instance_ids.

To override the contents of this collection use set_instance_ids.

The managed node IDs against which this command was requested.

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

The managed node IDs against which this command was requested.

pub fn get_instance_ids(&self) -> &Option<Vec<String>>

The managed node IDs against which this command was requested.

pub fn targets(self, input: Target) -> Self

Appends an item to targets.

To override the contents of this collection use set_targets.

An array of search criteria that targets managed nodes using a Key,Value combination that you specify. Targets is required if you don't provide one or more managed node IDs in the call.

pub fn set_targets(self, input: Option<Vec<Target>>) -> Self

An array of search criteria that targets managed nodes using a Key,Value combination that you specify. Targets is required if you don't provide one or more managed node IDs in the call.

pub fn get_targets(&self) -> &Option<Vec<Target>>

An array of search criteria that targets managed nodes using a Key,Value combination that you specify. Targets is required if you don't provide one or more managed node IDs in the call.

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

The date and time the command was requested.

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

The date and time the command was requested.

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

The date and time the command was requested.

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

The status of the command.

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

The status of the command.

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

The status of the command.

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

A detailed status of the command 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 any managed nodes.

• In Progress: The command has been sent to at least one managed node but hasn't reached a final state on all managed nodes.

• Success: The command successfully ran on all invocations. This is a terminal state.

• Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.

• Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.

• Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.

• Incomplete: The command was attempted on all managed nodes and one or more invocations doesn't have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.

• Cancelled: The command was terminated before it was completed. This is a terminal state.

• Rate Exceeded: The number of managed nodes targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any managed node. 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.

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

A detailed status of the command 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 any managed nodes.

• In Progress: The command has been sent to at least one managed node but hasn't reached a final state on all managed nodes.

• Success: The command successfully ran on all invocations. This is a terminal state.

• Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.

• Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.

• Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.

• Incomplete: The command was attempted on all managed nodes and one or more invocations doesn't have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.

• Cancelled: The command was terminated before it was completed. This is a terminal state.

• Rate Exceeded: The number of managed nodes targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any managed node. 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.

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

A detailed status of the command 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 any managed nodes.

• In Progress: The command has been sent to at least one managed node but hasn't reached a final state on all managed nodes.

• Success: The command successfully ran on all invocations. This is a terminal state.

• Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.

• Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.

• Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.

• Incomplete: The command was attempted on all managed nodes and one or more invocations doesn't have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.

• Cancelled: The command was terminated before it was completed. This is a terminal state.

• Rate Exceeded: The number of managed nodes targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any managed node. 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.

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

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

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

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

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

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

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.

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.

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.

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.

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.

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.

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

The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a number of managed nodes, such as 10, or a percentage of nodes, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Running commands using Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.

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

The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a number of managed nodes, such as 10, or a percentage of nodes, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Running commands using Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.

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

The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a number of managed nodes, such as 10, or a percentage of nodes, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Running commands using Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.

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

The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 0. For more information about how to use MaxErrors, see Running commands using Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.

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

The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 0. For more information about how to use MaxErrors, see Running commands using Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.

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

The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 0. For more information about how to use MaxErrors, see Running commands using Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.

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

The number of targets for the command.

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

The number of targets for the command.

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

The number of targets for the command.

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

The number of targets for which the command invocation reached a terminal state. Terminal states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Cancelled, Terminated, or Undeliverable.

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

The number of targets for which the command invocation reached a terminal state. Terminal states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Cancelled, Terminated, or Undeliverable.

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

The number of targets for which the command invocation reached a terminal state. Terminal states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Cancelled, Terminated, or Undeliverable.

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

The number of targets for which the status is Failed or Execution Timed Out.

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

The number of targets for which the status is Failed or Execution Timed Out.

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

The number of targets for which the status is Failed or Execution Timed Out.

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

The number of targets for which the status is Delivery Timed Out.

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

The number of targets for which the status is Delivery Timed Out.

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

The number of targets for which the status is Delivery Timed Out.

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

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.

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

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.

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

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.

pub fn notification_config(self, input: NotificationConfig) -> Self

Configurations for sending notifications about command status changes.

pub fn set_notification_config(self, input: Option<NotificationConfig>) -> Self

Configurations for sending notifications about command status changes.

pub fn get_notification_config(&self) -> &Option<NotificationConfig>

Configurations for sending notifications about command status changes.

pub fn cloud_watch_output_config(self, input: CloudWatchOutputConfig) -> Self

Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.

pub fn set_cloud_watch_output_config( self, input: Option<CloudWatchOutputConfig> ) -> Self

Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.

pub fn get_cloud_watch_output_config(&self) -> &Option<CloudWatchOutputConfig>

Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.

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

The TimeoutSeconds value specified for a command.

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

The TimeoutSeconds value specified for a command.

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

The TimeoutSeconds value specified for a command.

pub fn alarm_configuration(self, input: AlarmConfiguration) -> Self

The details for the CloudWatch alarm applied to your command.

pub fn set_alarm_configuration(self, input: Option<AlarmConfiguration>) -> Self

The details for the CloudWatch alarm applied to your command.

pub fn get_alarm_configuration(&self) -> &Option<AlarmConfiguration>

The details for the CloudWatch alarm applied to your command.

pub fn triggered_alarms(self, input: AlarmStateInformation) -> Self

Appends an item to triggered_alarms.

To override the contents of this collection use set_triggered_alarms.

The CloudWatch alarm that was invoked by the command.

pub fn set_triggered_alarms( self, input: Option<Vec<AlarmStateInformation>> ) -> Self

The CloudWatch alarm that was invoked by the command.

pub fn get_triggered_alarms(&self) -> &Option<Vec<AlarmStateInformation>>

The CloudWatch alarm that was invoked by the command.

pub fn build(self) -> Command

Consumes the builder and constructs a Command.

Trait Implementations

impl Clone for CommandBuilder

fn clone(&self) -> CommandBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommandBuilder

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

Formats the value using the given formatter.

impl Default for CommandBuilder

fn default() -> CommandBuilder

Returns the “default value” for a type.

impl PartialEq for CommandBuilder

fn eq(&self, other: &CommandBuilder) -> 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 CommandBuilder