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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-ssm/types.rb

Overview

Note:

When making an API call, you may pass MaintenanceWindowRunCommandParameters data as a 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.

<note markdown=“1”> `LoggingInfo` has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix` options in the `TaskInvocationParameters` structure. For information about how Amazon Web Services 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`.

</note>

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_output_configTypes::CloudWatchOutputConfig

Configuration options for sending command output to Amazon CloudWatch Logs.


13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
# File 'lib/aws-sdk-ssm/types.rb', line 13408

class MaintenanceWindowRunCommandParameters < Struct.new(
  :comment,
  :cloud_watch_output_config,
  :document_hash,
  :document_hash_type,
  :document_version,
  :notification_config,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :parameters,
  :service_role_arn,
  :timeout_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#commentString

Information about the commands to run.

Returns:

  • (String)

13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
# File 'lib/aws-sdk-ssm/types.rb', line 13408

class MaintenanceWindowRunCommandParameters < Struct.new(
  :comment,
  :cloud_watch_output_config,
  :document_hash,
  :document_hash_type,
  :document_version,
  :notification_config,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :parameters,
  :service_role_arn,
  :timeout_seconds)
  SENSITIVE = []
  include Aws::Structure
end

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

13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
# File 'lib/aws-sdk-ssm/types.rb', line 13408

class MaintenanceWindowRunCommandParameters < Struct.new(
  :comment,
  :cloud_watch_output_config,
  :document_hash,
  :document_hash_type,
  :document_version,
  :notification_config,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :parameters,
  :service_role_arn,
  :timeout_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#document_hash_typeString

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

Returns:

  • (String)

13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
# File 'lib/aws-sdk-ssm/types.rb', line 13408

class MaintenanceWindowRunCommandParameters < Struct.new(
  :comment,
  :cloud_watch_output_config,
  :document_hash,
  :document_hash_type,
  :document_version,
  :notification_config,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :parameters,
  :service_role_arn,
  :timeout_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#document_versionString

The Amazon Web Services Systems Manager document (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 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:

`–document-version “$DEFAULT”`

`–document-version “$LATEST”`

`–document-version “3”`

Returns:

  • (String)

13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
# File 'lib/aws-sdk-ssm/types.rb', line 13408

class MaintenanceWindowRunCommandParameters < Struct.new(
  :comment,
  :cloud_watch_output_config,
  :document_hash,
  :document_hash_type,
  :document_version,
  :notification_config,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :parameters,
  :service_role_arn,
  :timeout_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#notification_configTypes::NotificationConfig

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


13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
# File 'lib/aws-sdk-ssm/types.rb', line 13408

class MaintenanceWindowRunCommandParameters < Struct.new(
  :comment,
  :cloud_watch_output_config,
  :document_hash,
  :document_hash_type,
  :document_version,
  :notification_config,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :parameters,
  :service_role_arn,
  :timeout_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#output_s3_bucket_nameString

The name of the Amazon Simple Storage Service (Amazon S3) bucket.

Returns:

  • (String)

13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
# File 'lib/aws-sdk-ssm/types.rb', line 13408

class MaintenanceWindowRunCommandParameters < Struct.new(
  :comment,
  :cloud_watch_output_config,
  :document_hash,
  :document_hash_type,
  :document_version,
  :notification_config,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :parameters,
  :service_role_arn,
  :timeout_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#output_s3_key_prefixString

The S3 bucket subfolder.

Returns:

  • (String)

13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
# File 'lib/aws-sdk-ssm/types.rb', line 13408

class MaintenanceWindowRunCommandParameters < Struct.new(
  :comment,
  :cloud_watch_output_config,
  :document_hash,
  :document_hash_type,
  :document_version,
  :notification_config,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :parameters,
  :service_role_arn,
  :timeout_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#parametersHash<String,Array<String>>

The parameters for the `RUN_COMMAND` task execution.

Returns:

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

13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
# File 'lib/aws-sdk-ssm/types.rb', line 13408

class MaintenanceWindowRunCommandParameters < Struct.new(
  :comment,
  :cloud_watch_output_config,
  :document_hash,
  :document_hash_type,
  :document_version,
  :notification_config,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :parameters,
  :service_role_arn,
  :timeout_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#service_role_arnString

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

Returns:

  • (String)

13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
# File 'lib/aws-sdk-ssm/types.rb', line 13408

class MaintenanceWindowRunCommandParameters < Struct.new(
  :comment,
  :cloud_watch_output_config,
  :document_hash,
  :document_hash_type,
  :document_version,
  :notification_config,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :parameters,
  :service_role_arn,
  :timeout_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#timeout_secondsInteger

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

Returns:

  • (Integer)

13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
# File 'lib/aws-sdk-ssm/types.rb', line 13408

class MaintenanceWindowRunCommandParameters < Struct.new(
  :comment,
  :cloud_watch_output_config,
  :document_hash,
  :document_hash_type,
  :document_version,
  :notification_config,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :parameters,
  :service_role_arn,
  :timeout_seconds)
  SENSITIVE = []
  include Aws::Structure
end