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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
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.

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

See Also:

Constant Summary collapse

SENSITIVE = 
[:parameters]

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_output_config ⇒ Types::CloudWatchOutputConfig

Configuration options for sending command output to Amazon CloudWatch Logs.

Returns:



13015
13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
 
# File 'lib/aws-sdk-ssm/types.rb', line 13015

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) 


13015
13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
 
# File 'lib/aws-sdk-ssm/types.rb', line 13015

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) 


13015
13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
 
# File 'lib/aws-sdk-ssm/types.rb', line 13015

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) 


13015
13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
 
# File 'lib/aws-sdk-ssm/types.rb', line 13015

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) 


13015
13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
 
# File 'lib/aws-sdk-ssm/types.rb', line 13015

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:



13015
13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
 
# File 'lib/aws-sdk-ssm/types.rb', line 13015

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) 


13015
13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
 
# File 'lib/aws-sdk-ssm/types.rb', line 13015

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) 


13015
13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
 
# File 'lib/aws-sdk-ssm/types.rb', line 13015

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


13015
13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
 
# File 'lib/aws-sdk-ssm/types.rb', line 13015

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 IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run ‘RegisterTaskWithMaintenanceWindow`.

However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see [Setting up Maintenance Windows] in the in the *Amazon Web Services Systems Manager User Guide*.

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html

Returns:

  • (String) 


13015
13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
 
# File 'lib/aws-sdk-ssm/types.rb', line 13015

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) 


13015
13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
 
# File 'lib/aws-sdk-ssm/types.rb', line 13015

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