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

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

Overview

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

Constant Summary collapse

SENSITIVE =
[:parameters]

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_output_configTypes::CloudWatchOutputConfig

Configuration options for sending command output to Amazon CloudWatch Logs.



12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12156

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 = [:parameters]
  include Aws::Structure
end

#commentString

Information about the commands to run.

Returns:

  • (String)


12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12156

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 = [:parameters]
  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)


12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12156

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 = [:parameters]
  include Aws::Structure
end

#document_hash_typeString

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

Returns:

  • (String)


12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12156

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 = [:parameters]
  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)


12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12156

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 = [:parameters]
  include Aws::Structure
end

#notification_configTypes::NotificationConfig

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



12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12156

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 = [:parameters]
  include Aws::Structure
end

#output_s3_bucket_nameString

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

Returns:

  • (String)


12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12156

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 = [:parameters]
  include Aws::Structure
end

#output_s3_key_prefixString

The S3 bucket subfolder.

Returns:

  • (String)


12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12156

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 = [:parameters]
  include Aws::Structure
end

#parametersHash<String,Array<String>>

The parameters for the RUN_COMMAND task execution.

Returns:

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


12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12156

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 = [:parameters]
  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)


12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12156

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 = [:parameters]
  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)


12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12156

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 = [:parameters]
  include Aws::Structure
end