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",
  document_hash: "DocumentHash",
  document_hash_type: "Sha256", # accepts Sha256, Sha1
  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:

Instance Attribute Summary collapse

Instance Attribute Details

#commentString

Information about the commands to run.

Returns:

  • (String)

    Information about the commands to run.

#document_hashString

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_typeString

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

Possible values:

  • Sha256
  • Sha1

Returns:

  • (String)

    SHA-256 or SHA-1.

#notification_configTypes::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_nameString

The name of the Amazon S3 bucket.

Returns:

  • (String)

    The name of the Amazon S3 bucket.

#output_s3_key_prefixString

The Amazon S3 bucket subfolder.

Returns:

  • (String)

    The Amazon S3 bucket subfolder.

#parametersHash<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_arnString

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_secondsInteger

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.