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

Class: Aws::SSM::Types::MaintenanceWindowRunCommandParameters

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

Overview

Note:

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

{
  comment: "Comment",
  cloud_watch_output_config: {
    cloud_watch_log_group_name: "CloudWatchLogGroupName",
    cloud_watch_output_enabled: false,
  },
  document_hash: "DocumentHash",
  document_hash_type: "Sha256", # accepts Sha256, Sha1
  document_version: "DocumentVersion",
  notification_config: {
    notification_arn: "NotificationArn",
    notification_events: ["All"], # accepts All, InProgress, Success, TimedOut, Cancelled, Failed
    notification_type: "Command", # accepts Command, Invocation
  },
  output_s3_bucket_name: "S3BucketName",
  output_s3_key_prefix: "S3KeyPrefix",
  parameters: {
    "ParameterName" => ["ParameterValue"],
  },
  service_role_arn: "ServiceRole",
  timeout_seconds: 1,
}

The parameters for a RUN_COMMAND task type.

For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.

LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

For Run Command tasks, Systems Manager uses specified values for TaskParameters and LoggingInfo only if no values are specified for TaskInvocationParameters.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_output_config ⇒ Types::CloudWatchOutputConfig

Configuration options for sending command output to CloudWatch Logs.

Returns:

#comment ⇒ String

Information about the commands to run.

Returns:

  • (String) —

    Information about the commands to run.

#document_hash ⇒ String

The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.

Returns:

  • (String) —

    The SHA-256 or SHA-1 hash created by the system when the document was created.

#document_hash_type ⇒ String

SHA-256 or SHA-1. SHA-1 hashes have been deprecated.

Possible values:

  • Sha256
  • Sha1

Returns:

  • (String) —

    SHA-256 or SHA-1.

#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.

#notification_config ⇒ Types::NotificationConfig

Configurations for sending notifications about command status changes on a per-instance basis.

Returns:

  • (Types::NotificationConfig) —

    Configurations for sending notifications about command status changes on a per-instance basis.

#output_s3_bucket_name ⇒ String

The name of the S3 bucket.

Returns:

  • (String) —

    The name of the S3 bucket.

#output_s3_key_prefix ⇒ String

The S3 bucket subfolder.

Returns:

  • (String) —

    The S3 bucket subfolder.

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

The parameters for the RUN_COMMAND task execution.

Returns:

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

    The parameters for the RUN_COMMAND task execution.

#service_role_arn ⇒ String

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

Returns:

  • (String) —

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

#timeout_seconds ⇒ Integer

If this time is reached and the command has not already started running, it doesn\'t run.

Returns:

  • (Integer) —

    If this time is reached and the command has not already started running, it doesn\'t run.