You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

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

Instance Attribute Summary collapse

Instance Attribute Details

#commentString

Information about the command(s) to execute.

Returns:

  • (String)


7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7131

class MaintenanceWindowRunCommandParameters < Struct.new(
  :comment,
  :document_hash,
  :document_hash_type,
  :notification_config,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :parameters,
  :service_role_arn,
  :timeout_seconds)
  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)


7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7131

class MaintenanceWindowRunCommandParameters < Struct.new(
  :comment,
  :document_hash,
  :document_hash_type,
  :notification_config,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :parameters,
  :service_role_arn,
  :timeout_seconds)
  include Aws::Structure
end

#document_hash_typeString

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

Returns:

  • (String)


7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7131

class MaintenanceWindowRunCommandParameters < Struct.new(
  :comment,
  :document_hash,
  :document_hash_type,
  :notification_config,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :parameters,
  :service_role_arn,
  :timeout_seconds)
  include Aws::Structure
end

#notification_configTypes::NotificationConfig

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



7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7131

class MaintenanceWindowRunCommandParameters < Struct.new(
  :comment,
  :document_hash,
  :document_hash_type,
  :notification_config,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :parameters,
  :service_role_arn,
  :timeout_seconds)
  include Aws::Structure
end

#output_s3_bucket_nameString

The name of the Amazon S3 bucket.

Returns:

  • (String)


7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7131

class MaintenanceWindowRunCommandParameters < Struct.new(
  :comment,
  :document_hash,
  :document_hash_type,
  :notification_config,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :parameters,
  :service_role_arn,
  :timeout_seconds)
  include Aws::Structure
end

#output_s3_key_prefixString

The Amazon S3 bucket subfolder.

Returns:

  • (String)


7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7131

class MaintenanceWindowRunCommandParameters < Struct.new(
  :comment,
  :document_hash,
  :document_hash_type,
  :notification_config,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :parameters,
  :service_role_arn,
  :timeout_seconds)
  include Aws::Structure
end

#parametersHash<String,Array<String>>

The parameters for the RUN_COMMAND task execution.

Returns:

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


7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7131

class MaintenanceWindowRunCommandParameters < Struct.new(
  :comment,
  :document_hash,
  :document_hash_type,
  :notification_config,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :parameters,
  :service_role_arn,
  :timeout_seconds)
  include Aws::Structure
end

#service_role_arnString

The IAM service role to assume during task execution.

Returns:

  • (String)


7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7131

class MaintenanceWindowRunCommandParameters < Struct.new(
  :comment,
  :document_hash,
  :document_hash_type,
  :notification_config,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :parameters,
  :service_role_arn,
  :timeout_seconds)
  include Aws::Structure
end

#timeout_secondsInteger

If this time is reached and the command has not already started executing, it doesn not execute.

Returns:

  • (Integer)


7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7131

class MaintenanceWindowRunCommandParameters < Struct.new(
  :comment,
  :document_hash,
  :document_hash_type,
  :notification_config,
  :output_s3_bucket_name,
  :output_s3_key_prefix,
  :parameters,
  :service_role_arn,
  :timeout_seconds)
  include Aws::Structure
end