You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SSM::Types::SendCommandRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing SendCommandRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  instance_ids: ["InstanceId"],
  targets: [
    {
      key: "TargetKey",
      values: ["TargetValue"],
    },
  ],
  document_name: "DocumentARN", # required
  document_version: "DocumentVersion",
  document_hash: "DocumentHash",
  document_hash_type: "Sha256", # accepts Sha256, Sha1
  timeout_seconds: 1,
  comment: "Comment",
  parameters: {
    "ParameterName" => ["ParameterValue"],
  },
  output_s3_region: "S3Region",
  output_s3_bucket_name: "S3BucketName",
  output_s3_key_prefix: "S3KeyPrefix",
  max_concurrency: "MaxConcurrency",
  max_errors: "MaxErrors",
  service_role_arn: "ServiceRole",
  notification_config: {
    notification_arn: "NotificationArn",
    notification_events: ["All"], # accepts All, InProgress, Success, TimedOut, Cancelled, Failed
    notification_type: "Command", # accepts Command, Invocation
  },
  cloud_watch_output_config: {
    cloud_watch_log_group_name: "CloudWatchLogGroupName",
    cloud_watch_output_enabled: false,
  },
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_output_config ⇒ Types::CloudWatchOutputConfig

Enables Systems Manager to send Run Command output to Amazon CloudWatch Logs.

Returns:

#comment ⇒ String

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

Returns:

  • (String) —

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

#document_hash ⇒ String

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

Sha1 hashes have been deprecated.

Returns:

  • (String) —

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

#document_hash_type ⇒ String

Sha256 or Sha1.

Sha1 hashes have been deprecated.

Possible values:

  • Sha256
  • Sha1

Returns:

  • (String) —

    Sha256 or Sha1.

#document_name ⇒ String

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

Returns:

  • (String) —

    Required.

#document_version ⇒ String

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

--document-version \"\$DEFAULT\"

--document-version \"\$LATEST\"

--document-version \"3\"

Returns:

  • (String) —

    The SSM document version to use in the request.

#instance_ids ⇒ Array<String>

The IDs of the instances where the command should run. Specifying instance IDs is most useful when you are targeting a limited number of instances, though you can specify up to 50 IDs.

To target a larger number of instances, or if you prefer not to list individual instance IDs, we recommend using the Targets option instead. Using Targets, which accepts tag key-value pairs to identify the instances to send commands to, you can a send command to tens, hundreds, or thousands of instances at once.

For more information about how to use targets, see Using targets and rate controls to send commands to a fleet in the AWS Systems Manager User Guide.

Returns:

  • (Array<String>) —

    The IDs of the instances where the command should run.

#max_concurrency ⇒ String

(Optional) The maximum number of instances 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 50. For more information about how to use MaxConcurrency, see Using concurrency controls in the AWS Systems Manager User Guide.

Returns:

  • (String) —

    (Optional) The maximum number of instances that are allowed to run the command at the same time.

#max_errors ⇒ 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 0. For more information about how to use MaxErrors, see Using error controls in the AWS Systems Manager User Guide.

Returns:

  • (String) —

    The maximum number of errors allowed without the command failing.

#notification_config ⇒ Types::NotificationConfig

Configurations for sending notifications.

Returns:

#output_s3_bucket_name ⇒ String

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

Returns:

  • (String) —

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

#output_s3_key_prefix ⇒ String

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

Returns:

  • (String) —

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

#output_s3_region ⇒ String

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

Returns:

  • (String) —

    (Deprecated) You can no longer specify this parameter.

#parameters ⇒ Hash<String,Array<String>>

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

Returns:

  • (Hash<String,Array<String>>) —

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

#service_role_arn ⇒ String

The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.

Returns:

  • (String) —

    The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.

#targets ⇒ Array<Types::Target>

An array of search criteria that targets instances using a Key,Value combination that you specify. Specifying targets is most useful when you want to send a command to a large number of instances at once. Using Targets, which accepts tag key-value pairs to identify instances, you can send a command to tens, hundreds, or thousands of instances at once.

To send a command to a smaller number of instances, you can use the InstanceIds option instead.

For more information about how to use targets, see Sending commands to a fleet in the AWS Systems Manager User Guide.

Returns:

  • (Array<Types::Target>) —

    An array of search criteria that targets instances using a Key,Value combination that you specify.

#timeout_seconds ⇒ Integer

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

Returns:

  • (Integer) —

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