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

Inherits:

Struct

• Object
• Struct
• Aws::SSM::Types::MaintenanceWindowRunCommandParameters

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:parameters]

Instance Attribute Summary

• #cloud_watch_output_config ⇒ Types::CloudWatchOutputConfig

  Configuration options for sending command output to Amazon CloudWatch Logs.

• #comment ⇒ 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.

• #document_hash_type ⇒ String

  SHA-256 or SHA-1.

• #document_version ⇒ String

  The Amazon Web Services Systems Manager document (SSM document) version to use in the request.

• #notification_config ⇒ Types::NotificationConfig

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

• #output_s3_bucket_name ⇒ String

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

• #output_s3_key_prefix ⇒ String

  The S3 bucket subfolder.

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

  The parameters for the RUN_COMMAND task execution.

• #service_role_arn ⇒ String

  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.

• #timeout_seconds ⇒ Integer

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

Instance Attribute Details

#cloud_watch_output_config ⇒ Types::CloudWatchOutputConfig

Configuration options for sending command output to Amazon CloudWatch Logs.

Returns:

• (Types::CloudWatchOutputConfig)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12555

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

#comment ⇒ String

Information about the commands to run.

Returns:

• (String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12555

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

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12555

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_type ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12555

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_version ⇒ String

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)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12555

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_config ⇒ Types::NotificationConfig

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

Returns:

• (Types::NotificationConfig)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12555

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_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12555

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_prefix ⇒ String

The S3 bucket subfolder.

Returns:

• (String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12555

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

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

The parameters for the RUN_COMMAND task execution.

Returns:

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

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12555

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_arn ⇒ String

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)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12555

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_seconds ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12555

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