1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq)]
pub struct SendCommandInput {
/// <p>The IDs of the managed nodes where the command should run. Specifying managed node IDs is most useful when you are targeting a limited number of managed nodes, though you can specify up to 50 IDs.</p>
/// <p>To target a larger number of managed nodes, or if you prefer not to list individual node IDs, we recommend using the <code>Targets</code> option instead. Using <code>Targets</code>, which accepts tag key-value pairs to identify the managed nodes to send commands to, you can a send command to tens, hundreds, or thousands of nodes at once.</p>
/// <p>For more information about how to use targets, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html">Run commands at scale</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
pub instance_ids: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
/// <p>An array of search criteria that targets managed nodes using a <code>Key,Value</code> combination that you specify. Specifying targets is most useful when you want to send a command to a large number of managed nodes at once. Using <code>Targets</code>, which accepts tag key-value pairs to identify managed nodes, you can send a command to tens, hundreds, or thousands of nodes at once.</p>
/// <p>To send a command to a smaller number of managed nodes, you can use the <code>InstanceIds</code> option instead.</p>
/// <p>For more information about how to use targets, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html">Run commands at scale</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
pub targets: ::std::option::Option<::std::vec::Vec<crate::types::Target>>,
/// <p>The name of the Amazon Web Services Systems Manager document (SSM document) to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document Amazon Resource Name (ARN). For more information about how to use shared documents, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html">Sharing SSM documents</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p><note>
/// <p>If you specify a document name or ARN that hasn't been shared with your account, you receive an <code>InvalidDocument</code> error.</p>
/// </note>
pub document_name: ::std::option::Option<::std::string::String>,
/// <p>The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Command Line Interface (Amazon Web Services CLI), then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:</p>
/// <p>--document-version "\$DEFAULT"</p>
/// <p>--document-version "\$LATEST"</p>
/// <p>--document-version "3"</p>
pub document_version: ::std::option::Option<::std::string::String>,
/// <p>The Sha256 or Sha1 hash created by the system when the document was created.</p><note>
/// <p>Sha1 hashes have been deprecated.</p>
/// </note>
pub document_hash: ::std::option::Option<::std::string::String>,
/// <p>Sha256 or Sha1.</p><note>
/// <p>Sha1 hashes have been deprecated.</p>
/// </note>
pub document_hash_type: ::std::option::Option<crate::types::DocumentHashType>,
/// <p>If this time is reached and the command hasn't already started running, it won't run.</p>
pub timeout_seconds: ::std::option::Option<i32>,
/// <p>User-specified information about the command, such as a brief description of what the command should do.</p>
pub comment: ::std::option::Option<::std::string::String>,
/// <p>The required and optional parameters specified in the document being run.</p>
pub parameters: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::vec::Vec<::std::string::String>>>,
/// <p>(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.</p>
pub output_s3_region: ::std::option::Option<::std::string::String>,
/// <p>The name of the S3 bucket where command execution responses should be stored.</p>
pub output_s3_bucket_name: ::std::option::Option<::std::string::String>,
/// <p>The directory structure within the S3 bucket where the responses should be stored.</p>
pub output_s3_key_prefix: ::std::option::Option<::std::string::String>,
/// <p>(Optional) The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is <code>50</code>. For more information about how to use <code>MaxConcurrency</code>, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-velocity">Using concurrency controls</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
pub max_concurrency: ::std::option::Option<::std::string::String>,
/// <p>The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of <code>MaxErrors</code>, 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 <code>0</code>. For more information about how to use <code>MaxErrors</code>, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-maxerrors">Using error controls</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
pub max_errors: ::std::option::Option<::std::string::String>,
/// <p>The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.</p>
/// <p>This role must provide the <code>sns:Publish</code> permission for your notification topic. For information about creating and using this service role, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html">Monitoring Systems Manager status changes using Amazon SNS notifications</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
pub service_role_arn: ::std::option::Option<::std::string::String>,
/// <p>Configurations for sending notifications.</p>
pub notification_config: ::std::option::Option<crate::types::NotificationConfig>,
/// <p>Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a capability of Amazon Web Services Systems Manager.</p>
pub cloud_watch_output_config: ::std::option::Option<crate::types::CloudWatchOutputConfig>,
/// <p>The CloudWatch alarm you want to apply to your command.</p>
pub alarm_configuration: ::std::option::Option<crate::types::AlarmConfiguration>,
}
impl SendCommandInput {
/// <p>The IDs of the managed nodes where the command should run. Specifying managed node IDs is most useful when you are targeting a limited number of managed nodes, though you can specify up to 50 IDs.</p>
/// <p>To target a larger number of managed nodes, or if you prefer not to list individual node IDs, we recommend using the <code>Targets</code> option instead. Using <code>Targets</code>, which accepts tag key-value pairs to identify the managed nodes to send commands to, you can a send command to tens, hundreds, or thousands of nodes at once.</p>
/// <p>For more information about how to use targets, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html">Run commands at scale</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.instance_ids.is_none()`.
pub fn instance_ids(&self) -> &[::std::string::String] {
self.instance_ids.as_deref().unwrap_or_default()
}
/// <p>An array of search criteria that targets managed nodes using a <code>Key,Value</code> combination that you specify. Specifying targets is most useful when you want to send a command to a large number of managed nodes at once. Using <code>Targets</code>, which accepts tag key-value pairs to identify managed nodes, you can send a command to tens, hundreds, or thousands of nodes at once.</p>
/// <p>To send a command to a smaller number of managed nodes, you can use the <code>InstanceIds</code> option instead.</p>
/// <p>For more information about how to use targets, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html">Run commands at scale</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.targets.is_none()`.
pub fn targets(&self) -> &[crate::types::Target] {
self.targets.as_deref().unwrap_or_default()
}
/// <p>The name of the Amazon Web Services Systems Manager document (SSM document) to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document Amazon Resource Name (ARN). For more information about how to use shared documents, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html">Sharing SSM documents</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p><note>
/// <p>If you specify a document name or ARN that hasn't been shared with your account, you receive an <code>InvalidDocument</code> error.</p>
/// </note>
pub fn document_name(&self) -> ::std::option::Option<&str> {
self.document_name.as_deref()
}
/// <p>The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Command Line Interface (Amazon Web Services CLI), then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:</p>
/// <p>--document-version "\$DEFAULT"</p>
/// <p>--document-version "\$LATEST"</p>
/// <p>--document-version "3"</p>
pub fn document_version(&self) -> ::std::option::Option<&str> {
self.document_version.as_deref()
}
/// <p>The Sha256 or Sha1 hash created by the system when the document was created.</p><note>
/// <p>Sha1 hashes have been deprecated.</p>
/// </note>
pub fn document_hash(&self) -> ::std::option::Option<&str> {
self.document_hash.as_deref()
}
/// <p>Sha256 or Sha1.</p><note>
/// <p>Sha1 hashes have been deprecated.</p>
/// </note>
pub fn document_hash_type(&self) -> ::std::option::Option<&crate::types::DocumentHashType> {
self.document_hash_type.as_ref()
}
/// <p>If this time is reached and the command hasn't already started running, it won't run.</p>
pub fn timeout_seconds(&self) -> ::std::option::Option<i32> {
self.timeout_seconds
}
/// <p>User-specified information about the command, such as a brief description of what the command should do.</p>
pub fn comment(&self) -> ::std::option::Option<&str> {
self.comment.as_deref()
}
/// <p>The required and optional parameters specified in the document being run.</p>
pub fn parameters(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::vec::Vec<::std::string::String>>> {
self.parameters.as_ref()
}
/// <p>(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.</p>
pub fn output_s3_region(&self) -> ::std::option::Option<&str> {
self.output_s3_region.as_deref()
}
/// <p>The name of the S3 bucket where command execution responses should be stored.</p>
pub fn output_s3_bucket_name(&self) -> ::std::option::Option<&str> {
self.output_s3_bucket_name.as_deref()
}
/// <p>The directory structure within the S3 bucket where the responses should be stored.</p>
pub fn output_s3_key_prefix(&self) -> ::std::option::Option<&str> {
self.output_s3_key_prefix.as_deref()
}
/// <p>(Optional) The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is <code>50</code>. For more information about how to use <code>MaxConcurrency</code>, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-velocity">Using concurrency controls</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
pub fn max_concurrency(&self) -> ::std::option::Option<&str> {
self.max_concurrency.as_deref()
}
/// <p>The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of <code>MaxErrors</code>, 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 <code>0</code>. For more information about how to use <code>MaxErrors</code>, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-maxerrors">Using error controls</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
pub fn max_errors(&self) -> ::std::option::Option<&str> {
self.max_errors.as_deref()
}
/// <p>The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.</p>
/// <p>This role must provide the <code>sns:Publish</code> permission for your notification topic. For information about creating and using this service role, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html">Monitoring Systems Manager status changes using Amazon SNS notifications</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
pub fn service_role_arn(&self) -> ::std::option::Option<&str> {
self.service_role_arn.as_deref()
}
/// <p>Configurations for sending notifications.</p>
pub fn notification_config(&self) -> ::std::option::Option<&crate::types::NotificationConfig> {
self.notification_config.as_ref()
}
/// <p>Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a capability of Amazon Web Services Systems Manager.</p>
pub fn cloud_watch_output_config(&self) -> ::std::option::Option<&crate::types::CloudWatchOutputConfig> {
self.cloud_watch_output_config.as_ref()
}
/// <p>The CloudWatch alarm you want to apply to your command.</p>
pub fn alarm_configuration(&self) -> ::std::option::Option<&crate::types::AlarmConfiguration> {
self.alarm_configuration.as_ref()
}
}
impl ::std::fmt::Debug for SendCommandInput {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
let mut formatter = f.debug_struct("SendCommandInput");
formatter.field("instance_ids", &self.instance_ids);
formatter.field("targets", &self.targets);
formatter.field("document_name", &self.document_name);
formatter.field("document_version", &self.document_version);
formatter.field("document_hash", &self.document_hash);
formatter.field("document_hash_type", &self.document_hash_type);
formatter.field("timeout_seconds", &self.timeout_seconds);
formatter.field("comment", &self.comment);
formatter.field("parameters", &"*** Sensitive Data Redacted ***");
formatter.field("output_s3_region", &self.output_s3_region);
formatter.field("output_s3_bucket_name", &self.output_s3_bucket_name);
formatter.field("output_s3_key_prefix", &self.output_s3_key_prefix);
formatter.field("max_concurrency", &self.max_concurrency);
formatter.field("max_errors", &self.max_errors);
formatter.field("service_role_arn", &self.service_role_arn);
formatter.field("notification_config", &self.notification_config);
formatter.field("cloud_watch_output_config", &self.cloud_watch_output_config);
formatter.field("alarm_configuration", &self.alarm_configuration);
formatter.finish()
}
}
impl SendCommandInput {
/// Creates a new builder-style object to manufacture [`SendCommandInput`](crate::operation::send_command::SendCommandInput).
pub fn builder() -> crate::operation::send_command::builders::SendCommandInputBuilder {
crate::operation::send_command::builders::SendCommandInputBuilder::default()
}
}
/// A builder for [`SendCommandInput`](crate::operation::send_command::SendCommandInput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default)]
pub struct SendCommandInputBuilder {
pub(crate) instance_ids: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
pub(crate) targets: ::std::option::Option<::std::vec::Vec<crate::types::Target>>,
pub(crate) document_name: ::std::option::Option<::std::string::String>,
pub(crate) document_version: ::std::option::Option<::std::string::String>,
pub(crate) document_hash: ::std::option::Option<::std::string::String>,
pub(crate) document_hash_type: ::std::option::Option<crate::types::DocumentHashType>,
pub(crate) timeout_seconds: ::std::option::Option<i32>,
pub(crate) comment: ::std::option::Option<::std::string::String>,
pub(crate) parameters: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::vec::Vec<::std::string::String>>>,
pub(crate) output_s3_region: ::std::option::Option<::std::string::String>,
pub(crate) output_s3_bucket_name: ::std::option::Option<::std::string::String>,
pub(crate) output_s3_key_prefix: ::std::option::Option<::std::string::String>,
pub(crate) max_concurrency: ::std::option::Option<::std::string::String>,
pub(crate) max_errors: ::std::option::Option<::std::string::String>,
pub(crate) service_role_arn: ::std::option::Option<::std::string::String>,
pub(crate) notification_config: ::std::option::Option<crate::types::NotificationConfig>,
pub(crate) cloud_watch_output_config: ::std::option::Option<crate::types::CloudWatchOutputConfig>,
pub(crate) alarm_configuration: ::std::option::Option<crate::types::AlarmConfiguration>,
}
impl SendCommandInputBuilder {
/// Appends an item to `instance_ids`.
///
/// To override the contents of this collection use [`set_instance_ids`](Self::set_instance_ids).
///
/// <p>The IDs of the managed nodes where the command should run. Specifying managed node IDs is most useful when you are targeting a limited number of managed nodes, though you can specify up to 50 IDs.</p>
/// <p>To target a larger number of managed nodes, or if you prefer not to list individual node IDs, we recommend using the <code>Targets</code> option instead. Using <code>Targets</code>, which accepts tag key-value pairs to identify the managed nodes to send commands to, you can a send command to tens, hundreds, or thousands of nodes at once.</p>
/// <p>For more information about how to use targets, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html">Run commands at scale</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
pub fn instance_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.instance_ids.unwrap_or_default();
v.push(input.into());
self.instance_ids = ::std::option::Option::Some(v);
self
}
/// <p>The IDs of the managed nodes where the command should run. Specifying managed node IDs is most useful when you are targeting a limited number of managed nodes, though you can specify up to 50 IDs.</p>
/// <p>To target a larger number of managed nodes, or if you prefer not to list individual node IDs, we recommend using the <code>Targets</code> option instead. Using <code>Targets</code>, which accepts tag key-value pairs to identify the managed nodes to send commands to, you can a send command to tens, hundreds, or thousands of nodes at once.</p>
/// <p>For more information about how to use targets, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html">Run commands at scale</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
pub fn set_instance_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.instance_ids = input;
self
}
/// <p>The IDs of the managed nodes where the command should run. Specifying managed node IDs is most useful when you are targeting a limited number of managed nodes, though you can specify up to 50 IDs.</p>
/// <p>To target a larger number of managed nodes, or if you prefer not to list individual node IDs, we recommend using the <code>Targets</code> option instead. Using <code>Targets</code>, which accepts tag key-value pairs to identify the managed nodes to send commands to, you can a send command to tens, hundreds, or thousands of nodes at once.</p>
/// <p>For more information about how to use targets, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html">Run commands at scale</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
pub fn get_instance_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.instance_ids
}
/// Appends an item to `targets`.
///
/// To override the contents of this collection use [`set_targets`](Self::set_targets).
///
/// <p>An array of search criteria that targets managed nodes using a <code>Key,Value</code> combination that you specify. Specifying targets is most useful when you want to send a command to a large number of managed nodes at once. Using <code>Targets</code>, which accepts tag key-value pairs to identify managed nodes, you can send a command to tens, hundreds, or thousands of nodes at once.</p>
/// <p>To send a command to a smaller number of managed nodes, you can use the <code>InstanceIds</code> option instead.</p>
/// <p>For more information about how to use targets, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html">Run commands at scale</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
pub fn targets(mut self, input: crate::types::Target) -> Self {
let mut v = self.targets.unwrap_or_default();
v.push(input);
self.targets = ::std::option::Option::Some(v);
self
}
/// <p>An array of search criteria that targets managed nodes using a <code>Key,Value</code> combination that you specify. Specifying targets is most useful when you want to send a command to a large number of managed nodes at once. Using <code>Targets</code>, which accepts tag key-value pairs to identify managed nodes, you can send a command to tens, hundreds, or thousands of nodes at once.</p>
/// <p>To send a command to a smaller number of managed nodes, you can use the <code>InstanceIds</code> option instead.</p>
/// <p>For more information about how to use targets, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html">Run commands at scale</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
pub fn set_targets(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Target>>) -> Self {
self.targets = input;
self
}
/// <p>An array of search criteria that targets managed nodes using a <code>Key,Value</code> combination that you specify. Specifying targets is most useful when you want to send a command to a large number of managed nodes at once. Using <code>Targets</code>, which accepts tag key-value pairs to identify managed nodes, you can send a command to tens, hundreds, or thousands of nodes at once.</p>
/// <p>To send a command to a smaller number of managed nodes, you can use the <code>InstanceIds</code> option instead.</p>
/// <p>For more information about how to use targets, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html">Run commands at scale</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
pub fn get_targets(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Target>> {
&self.targets
}
/// <p>The name of the Amazon Web Services Systems Manager document (SSM document) to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document Amazon Resource Name (ARN). For more information about how to use shared documents, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html">Sharing SSM documents</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p><note>
/// <p>If you specify a document name or ARN that hasn't been shared with your account, you receive an <code>InvalidDocument</code> error.</p>
/// </note>
/// This field is required.
pub fn document_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.document_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the Amazon Web Services Systems Manager document (SSM document) to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document Amazon Resource Name (ARN). For more information about how to use shared documents, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html">Sharing SSM documents</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p><note>
/// <p>If you specify a document name or ARN that hasn't been shared with your account, you receive an <code>InvalidDocument</code> error.</p>
/// </note>
pub fn set_document_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.document_name = input;
self
}
/// <p>The name of the Amazon Web Services Systems Manager document (SSM document) to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document Amazon Resource Name (ARN). For more information about how to use shared documents, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html">Sharing SSM documents</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p><note>
/// <p>If you specify a document name or ARN that hasn't been shared with your account, you receive an <code>InvalidDocument</code> error.</p>
/// </note>
pub fn get_document_name(&self) -> &::std::option::Option<::std::string::String> {
&self.document_name
}
/// <p>The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Command Line Interface (Amazon Web Services CLI), then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:</p>
/// <p>--document-version "\$DEFAULT"</p>
/// <p>--document-version "\$LATEST"</p>
/// <p>--document-version "3"</p>
pub fn document_version(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.document_version = ::std::option::Option::Some(input.into());
self
}
/// <p>The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Command Line Interface (Amazon Web Services CLI), then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:</p>
/// <p>--document-version "\$DEFAULT"</p>
/// <p>--document-version "\$LATEST"</p>
/// <p>--document-version "3"</p>
pub fn set_document_version(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.document_version = input;
self
}
/// <p>The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Command Line Interface (Amazon Web Services CLI), then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:</p>
/// <p>--document-version "\$DEFAULT"</p>
/// <p>--document-version "\$LATEST"</p>
/// <p>--document-version "3"</p>
pub fn get_document_version(&self) -> &::std::option::Option<::std::string::String> {
&self.document_version
}
/// <p>The Sha256 or Sha1 hash created by the system when the document was created.</p><note>
/// <p>Sha1 hashes have been deprecated.</p>
/// </note>
pub fn document_hash(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.document_hash = ::std::option::Option::Some(input.into());
self
}
/// <p>The Sha256 or Sha1 hash created by the system when the document was created.</p><note>
/// <p>Sha1 hashes have been deprecated.</p>
/// </note>
pub fn set_document_hash(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.document_hash = input;
self
}
/// <p>The Sha256 or Sha1 hash created by the system when the document was created.</p><note>
/// <p>Sha1 hashes have been deprecated.</p>
/// </note>
pub fn get_document_hash(&self) -> &::std::option::Option<::std::string::String> {
&self.document_hash
}
/// <p>Sha256 or Sha1.</p><note>
/// <p>Sha1 hashes have been deprecated.</p>
/// </note>
pub fn document_hash_type(mut self, input: crate::types::DocumentHashType) -> Self {
self.document_hash_type = ::std::option::Option::Some(input);
self
}
/// <p>Sha256 or Sha1.</p><note>
/// <p>Sha1 hashes have been deprecated.</p>
/// </note>
pub fn set_document_hash_type(mut self, input: ::std::option::Option<crate::types::DocumentHashType>) -> Self {
self.document_hash_type = input;
self
}
/// <p>Sha256 or Sha1.</p><note>
/// <p>Sha1 hashes have been deprecated.</p>
/// </note>
pub fn get_document_hash_type(&self) -> &::std::option::Option<crate::types::DocumentHashType> {
&self.document_hash_type
}
/// <p>If this time is reached and the command hasn't already started running, it won't run.</p>
pub fn timeout_seconds(mut self, input: i32) -> Self {
self.timeout_seconds = ::std::option::Option::Some(input);
self
}
/// <p>If this time is reached and the command hasn't already started running, it won't run.</p>
pub fn set_timeout_seconds(mut self, input: ::std::option::Option<i32>) -> Self {
self.timeout_seconds = input;
self
}
/// <p>If this time is reached and the command hasn't already started running, it won't run.</p>
pub fn get_timeout_seconds(&self) -> &::std::option::Option<i32> {
&self.timeout_seconds
}
/// <p>User-specified information about the command, such as a brief description of what the command should do.</p>
pub fn comment(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.comment = ::std::option::Option::Some(input.into());
self
}
/// <p>User-specified information about the command, such as a brief description of what the command should do.</p>
pub fn set_comment(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.comment = input;
self
}
/// <p>User-specified information about the command, such as a brief description of what the command should do.</p>
pub fn get_comment(&self) -> &::std::option::Option<::std::string::String> {
&self.comment
}
/// Adds a key-value pair to `parameters`.
///
/// To override the contents of this collection use [`set_parameters`](Self::set_parameters).
///
/// <p>The required and optional parameters specified in the document being run.</p>
pub fn parameters(mut self, k: impl ::std::convert::Into<::std::string::String>, v: ::std::vec::Vec<::std::string::String>) -> Self {
let mut hash_map = self.parameters.unwrap_or_default();
hash_map.insert(k.into(), v);
self.parameters = ::std::option::Option::Some(hash_map);
self
}
/// <p>The required and optional parameters specified in the document being run.</p>
pub fn set_parameters(
mut self,
input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::vec::Vec<::std::string::String>>>,
) -> Self {
self.parameters = input;
self
}
/// <p>The required and optional parameters specified in the document being run.</p>
pub fn get_parameters(
&self,
) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::vec::Vec<::std::string::String>>> {
&self.parameters
}
/// <p>(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.</p>
pub fn output_s3_region(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.output_s3_region = ::std::option::Option::Some(input.into());
self
}
/// <p>(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.</p>
pub fn set_output_s3_region(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.output_s3_region = input;
self
}
/// <p>(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.</p>
pub fn get_output_s3_region(&self) -> &::std::option::Option<::std::string::String> {
&self.output_s3_region
}
/// <p>The name of the S3 bucket where command execution responses should be stored.</p>
pub fn output_s3_bucket_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.output_s3_bucket_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the S3 bucket where command execution responses should be stored.</p>
pub fn set_output_s3_bucket_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.output_s3_bucket_name = input;
self
}
/// <p>The name of the S3 bucket where command execution responses should be stored.</p>
pub fn get_output_s3_bucket_name(&self) -> &::std::option::Option<::std::string::String> {
&self.output_s3_bucket_name
}
/// <p>The directory structure within the S3 bucket where the responses should be stored.</p>
pub fn output_s3_key_prefix(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.output_s3_key_prefix = ::std::option::Option::Some(input.into());
self
}
/// <p>The directory structure within the S3 bucket where the responses should be stored.</p>
pub fn set_output_s3_key_prefix(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.output_s3_key_prefix = input;
self
}
/// <p>The directory structure within the S3 bucket where the responses should be stored.</p>
pub fn get_output_s3_key_prefix(&self) -> &::std::option::Option<::std::string::String> {
&self.output_s3_key_prefix
}
/// <p>(Optional) The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is <code>50</code>. For more information about how to use <code>MaxConcurrency</code>, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-velocity">Using concurrency controls</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
pub fn max_concurrency(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.max_concurrency = ::std::option::Option::Some(input.into());
self
}
/// <p>(Optional) The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is <code>50</code>. For more information about how to use <code>MaxConcurrency</code>, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-velocity">Using concurrency controls</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
pub fn set_max_concurrency(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.max_concurrency = input;
self
}
/// <p>(Optional) The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is <code>50</code>. For more information about how to use <code>MaxConcurrency</code>, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-velocity">Using concurrency controls</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
pub fn get_max_concurrency(&self) -> &::std::option::Option<::std::string::String> {
&self.max_concurrency
}
/// <p>The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of <code>MaxErrors</code>, 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 <code>0</code>. For more information about how to use <code>MaxErrors</code>, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-maxerrors">Using error controls</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
pub fn max_errors(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.max_errors = ::std::option::Option::Some(input.into());
self
}
/// <p>The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of <code>MaxErrors</code>, 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 <code>0</code>. For more information about how to use <code>MaxErrors</code>, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-maxerrors">Using error controls</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
pub fn set_max_errors(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.max_errors = input;
self
}
/// <p>The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of <code>MaxErrors</code>, 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 <code>0</code>. For more information about how to use <code>MaxErrors</code>, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-maxerrors">Using error controls</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
pub fn get_max_errors(&self) -> &::std::option::Option<::std::string::String> {
&self.max_errors
}
/// <p>The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.</p>
/// <p>This role must provide the <code>sns:Publish</code> permission for your notification topic. For information about creating and using this service role, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html">Monitoring Systems Manager status changes using Amazon SNS notifications</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
pub fn service_role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.service_role_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.</p>
/// <p>This role must provide the <code>sns:Publish</code> permission for your notification topic. For information about creating and using this service role, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html">Monitoring Systems Manager status changes using Amazon SNS notifications</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
pub fn set_service_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.service_role_arn = input;
self
}
/// <p>The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.</p>
/// <p>This role must provide the <code>sns:Publish</code> permission for your notification topic. For information about creating and using this service role, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html">Monitoring Systems Manager status changes using Amazon SNS notifications</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
pub fn get_service_role_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.service_role_arn
}
/// <p>Configurations for sending notifications.</p>
pub fn notification_config(mut self, input: crate::types::NotificationConfig) -> Self {
self.notification_config = ::std::option::Option::Some(input);
self
}
/// <p>Configurations for sending notifications.</p>
pub fn set_notification_config(mut self, input: ::std::option::Option<crate::types::NotificationConfig>) -> Self {
self.notification_config = input;
self
}
/// <p>Configurations for sending notifications.</p>
pub fn get_notification_config(&self) -> &::std::option::Option<crate::types::NotificationConfig> {
&self.notification_config
}
/// <p>Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a capability of Amazon Web Services Systems Manager.</p>
pub fn cloud_watch_output_config(mut self, input: crate::types::CloudWatchOutputConfig) -> Self {
self.cloud_watch_output_config = ::std::option::Option::Some(input);
self
}
/// <p>Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a capability of Amazon Web Services Systems Manager.</p>
pub fn set_cloud_watch_output_config(mut self, input: ::std::option::Option<crate::types::CloudWatchOutputConfig>) -> Self {
self.cloud_watch_output_config = input;
self
}
/// <p>Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a capability of Amazon Web Services Systems Manager.</p>
pub fn get_cloud_watch_output_config(&self) -> &::std::option::Option<crate::types::CloudWatchOutputConfig> {
&self.cloud_watch_output_config
}
/// <p>The CloudWatch alarm you want to apply to your command.</p>
pub fn alarm_configuration(mut self, input: crate::types::AlarmConfiguration) -> Self {
self.alarm_configuration = ::std::option::Option::Some(input);
self
}
/// <p>The CloudWatch alarm you want to apply to your command.</p>
pub fn set_alarm_configuration(mut self, input: ::std::option::Option<crate::types::AlarmConfiguration>) -> Self {
self.alarm_configuration = input;
self
}
/// <p>The CloudWatch alarm you want to apply to your command.</p>
pub fn get_alarm_configuration(&self) -> &::std::option::Option<crate::types::AlarmConfiguration> {
&self.alarm_configuration
}
/// Consumes the builder and constructs a [`SendCommandInput`](crate::operation::send_command::SendCommandInput).
pub fn build(self) -> ::std::result::Result<crate::operation::send_command::SendCommandInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::send_command::SendCommandInput {
instance_ids: self.instance_ids,
targets: self.targets,
document_name: self.document_name,
document_version: self.document_version,
document_hash: self.document_hash,
document_hash_type: self.document_hash_type,
timeout_seconds: self.timeout_seconds,
comment: self.comment,
parameters: self.parameters,
output_s3_region: self.output_s3_region,
output_s3_bucket_name: self.output_s3_bucket_name,
output_s3_key_prefix: self.output_s3_key_prefix,
max_concurrency: self.max_concurrency,
max_errors: self.max_errors,
service_role_arn: self.service_role_arn,
notification_config: self.notification_config,
cloud_watch_output_config: self.cloud_watch_output_config,
alarm_configuration: self.alarm_configuration,
})
}
}
impl ::std::fmt::Debug for SendCommandInputBuilder {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
let mut formatter = f.debug_struct("SendCommandInputBuilder");
formatter.field("instance_ids", &self.instance_ids);
formatter.field("targets", &self.targets);
formatter.field("document_name", &self.document_name);
formatter.field("document_version", &self.document_version);
formatter.field("document_hash", &self.document_hash);
formatter.field("document_hash_type", &self.document_hash_type);
formatter.field("timeout_seconds", &self.timeout_seconds);
formatter.field("comment", &self.comment);
formatter.field("parameters", &"*** Sensitive Data Redacted ***");
formatter.field("output_s3_region", &self.output_s3_region);
formatter.field("output_s3_bucket_name", &self.output_s3_bucket_name);
formatter.field("output_s3_key_prefix", &self.output_s3_key_prefix);
formatter.field("max_concurrency", &self.max_concurrency);
formatter.field("max_errors", &self.max_errors);
formatter.field("service_role_arn", &self.service_role_arn);
formatter.field("notification_config", &self.notification_config);
formatter.field("cloud_watch_output_config", &self.cloud_watch_output_config);
formatter.field("alarm_configuration", &self.alarm_configuration);
formatter.finish()
}
}