Struct rusoto_ssm::SendCommandRequest

pub struct SendCommandRequest {
    pub comment: Option<String>,
    pub document_hash: Option<String>,
    pub document_hash_type: Option<String>,
    pub document_name: String,
    pub instance_ids: Option<Vec<String>>,
    pub max_concurrency: Option<String>,
    pub max_errors: Option<String>,
    pub notification_config: Option<NotificationConfig>,
    pub output_s3_bucket_name: Option<String>,
    pub output_s3_key_prefix: Option<String>,
    pub output_s3_region: Option<String>,
    pub parameters: Option<HashMap<String, Vec<String>>>,
    pub service_role_arn: Option<String>,
    pub targets: Option<Vec<Target>>,
    pub timeout_seconds: Option<i64>,
}

Fields

comment: Option<String>

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

document_hash: Option<String>

The Sha256 or Sha1 hash created by the system when the document was created.

Sha1 hashes have been deprecated.

document_hash_type: Option<String>

Sha256 or Sha1.

Sha1 hashes have been deprecated.

document_name: String

Required. The name of the Systems Manager document to execute. This can be a public document or a custom document.

instance_ids: Option<Vec<String>>

The instance IDs where the command should execute. You can specify a maximum of 50 IDs. If you prefer not to list individual instance IDs, you can instead send commands to a fleet of instances using the Targets parameter, which accepts EC2 tags. For more information about how to use Targets, see Sending Commands to a Fleet.

max_concurrency: Option<String>

(Optional) The maximum number of instances that are allowed to execute the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using Concurrency Controls.

max_errors: Option<String>

The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 50. For more information about how to use MaxErrors, see Using Error Controls.

notification_config: Option<NotificationConfig>

Configurations for sending notifications.

output_s3_bucket_name: Option<String>

The name of the S3 bucket where command execution responses should be stored.

output_s3_key_prefix: Option<String>

The directory structure within the S3 bucket where the responses should be stored.

output_s3_region: Option<String>

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

parameters: Option<HashMap<String, Vec<String>>>

The required and optional parameters specified in the document being executed.

service_role_arn: Option<String>

The IAM role that Systems Manager uses to send notifications.

targets: Option<Vec<Target>>

(Optional) An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call. For more information about how to use Targets, see Sending Commands to a Fleet.

timeout_seconds: Option<i64>

If this time is reached and the command has not already started executing, it will not execute.

Trait Implementations

impl Default for SendCommandRequest

fn default() -> SendCommandRequest

Returns the "default value" for a type.

impl Debug for SendCommandRequest

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Clone for SendCommandRequest

fn clone(&self) -> SendCommandRequest

Returns a copy of the value.

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

Performs copy-assignment from source.