Class: Aws::SSM::Types::MaintenanceWindowTask

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

Overview

Information about a task defined for a maintenance window.

Constant Summary collapse

SENSITIVE =
[:task_parameters, :description]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A description of the task.

Returns:

  • (String)

13614
13615
13616
13617
13618
13619
13620
13621
13622
13623
13624
13625
13626
13627
13628
13629
13630
# File 'lib/aws-sdk-ssm/types.rb', line 13614

class MaintenanceWindowTask < Struct.new(
  :window_id,
  :window_task_id,
  :task_arn,
  :type,
  :targets,
  :task_parameters,
  :priority,
  :logging_info,
  :service_role_arn,
  :max_concurrency,
  :max_errors,
  :name,
  :description)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#logging_infoTypes::LoggingInfo

Information about an S3 bucket to write task-level logs to.

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

</note>

Returns:


13614
13615
13616
13617
13618
13619
13620
13621
13622
13623
13624
13625
13626
13627
13628
13629
13630
# File 'lib/aws-sdk-ssm/types.rb', line 13614

class MaintenanceWindowTask < Struct.new(
  :window_id,
  :window_task_id,
  :task_arn,
  :type,
  :targets,
  :task_parameters,
  :priority,
  :logging_info,
  :service_role_arn,
  :max_concurrency,
  :max_errors,
  :name,
  :description)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#max_concurrencyString

The maximum number of targets this task can be run for, in parallel.

Returns:

  • (String)

13614
13615
13616
13617
13618
13619
13620
13621
13622
13623
13624
13625
13626
13627
13628
13629
13630
# File 'lib/aws-sdk-ssm/types.rb', line 13614

class MaintenanceWindowTask < Struct.new(
  :window_id,
  :window_task_id,
  :task_arn,
  :type,
  :targets,
  :task_parameters,
  :priority,
  :logging_info,
  :service_role_arn,
  :max_concurrency,
  :max_errors,
  :name,
  :description)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#max_errorsString

The maximum number of errors allowed before this task stops being scheduled.

Returns:

  • (String)

13614
13615
13616
13617
13618
13619
13620
13621
13622
13623
13624
13625
13626
13627
13628
13629
13630
# File 'lib/aws-sdk-ssm/types.rb', line 13614

class MaintenanceWindowTask < Struct.new(
  :window_id,
  :window_task_id,
  :task_arn,
  :type,
  :targets,
  :task_parameters,
  :priority,
  :logging_info,
  :service_role_arn,
  :max_concurrency,
  :max_errors,
  :name,
  :description)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#nameString

The task name.

Returns:

  • (String)

13614
13615
13616
13617
13618
13619
13620
13621
13622
13623
13624
13625
13626
13627
13628
13629
13630
# File 'lib/aws-sdk-ssm/types.rb', line 13614

class MaintenanceWindowTask < Struct.new(
  :window_id,
  :window_task_id,
  :task_arn,
  :type,
  :targets,
  :task_parameters,
  :priority,
  :logging_info,
  :service_role_arn,
  :max_concurrency,
  :max_errors,
  :name,
  :description)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#priorityInteger

The priority of the task in the maintenance window. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

Returns:

  • (Integer)

13614
13615
13616
13617
13618
13619
13620
13621
13622
13623
13624
13625
13626
13627
13628
13629
13630
# File 'lib/aws-sdk-ssm/types.rb', line 13614

class MaintenanceWindowTask < Struct.new(
  :window_id,
  :window_task_id,
  :task_arn,
  :type,
  :targets,
  :task_parameters,
  :priority,
  :logging_info,
  :service_role_arn,
  :max_concurrency,
  :max_errors,
  :name,
  :description)
  SENSITIVE = [:task_parameters, :description]
  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)

13614
13615
13616
13617
13618
13619
13620
13621
13622
13623
13624
13625
13626
13627
13628
13629
13630
# File 'lib/aws-sdk-ssm/types.rb', line 13614

class MaintenanceWindowTask < Struct.new(
  :window_id,
  :window_task_id,
  :task_arn,
  :type,
  :targets,
  :task_parameters,
  :priority,
  :logging_info,
  :service_role_arn,
  :max_concurrency,
  :max_errors,
  :name,
  :description)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#targetsArray<Types::Target>

The targets (either instances or tags). Instances are specified using `Key=instanceids,Values=<instanceid1>,<instanceid2>`. Tags are specified using `Key=<tag name>,Values=<tag value>`.

Returns:


13614
13615
13616
13617
13618
13619
13620
13621
13622
13623
13624
13625
13626
13627
13628
13629
13630
# File 'lib/aws-sdk-ssm/types.rb', line 13614

class MaintenanceWindowTask < Struct.new(
  :window_id,
  :window_task_id,
  :task_arn,
  :type,
  :targets,
  :task_parameters,
  :priority,
  :logging_info,
  :service_role_arn,
  :max_concurrency,
  :max_errors,
  :name,
  :description)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#task_arnString

The resource that the task uses during execution. For `RUN_COMMAND` and `AUTOMATION` task types, `TaskArn` is the Amazon Web Services Systems Manager (SSM document) name or ARN. For `LAMBDA` tasks, it's the function name or ARN. For `STEP_FUNCTIONS` tasks, it's the state machine ARN.

Returns:

  • (String)

13614
13615
13616
13617
13618
13619
13620
13621
13622
13623
13624
13625
13626
13627
13628
13629
13630
# File 'lib/aws-sdk-ssm/types.rb', line 13614

class MaintenanceWindowTask < Struct.new(
  :window_id,
  :window_task_id,
  :task_arn,
  :type,
  :targets,
  :task_parameters,
  :priority,
  :logging_info,
  :service_role_arn,
  :max_concurrency,
  :max_errors,
  :name,
  :description)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#task_parametersHash<String,Types::MaintenanceWindowTaskParameterValueExpression>

The parameters that should be passed to the task when it is run.

<note markdown=“1”> `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.

</note>

13614
13615
13616
13617
13618
13619
13620
13621
13622
13623
13624
13625
13626
13627
13628
13629
13630
# File 'lib/aws-sdk-ssm/types.rb', line 13614

class MaintenanceWindowTask < Struct.new(
  :window_id,
  :window_task_id,
  :task_arn,
  :type,
  :targets,
  :task_parameters,
  :priority,
  :logging_info,
  :service_role_arn,
  :max_concurrency,
  :max_errors,
  :name,
  :description)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#typeString

The type of task.

Returns:

  • (String)

13614
13615
13616
13617
13618
13619
13620
13621
13622
13623
13624
13625
13626
13627
13628
13629
13630
# File 'lib/aws-sdk-ssm/types.rb', line 13614

class MaintenanceWindowTask < Struct.new(
  :window_id,
  :window_task_id,
  :task_arn,
  :type,
  :targets,
  :task_parameters,
  :priority,
  :logging_info,
  :service_role_arn,
  :max_concurrency,
  :max_errors,
  :name,
  :description)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#window_idString

The ID of the maintenance window where the task is registered.

Returns:

  • (String)

13614
13615
13616
13617
13618
13619
13620
13621
13622
13623
13624
13625
13626
13627
13628
13629
13630
# File 'lib/aws-sdk-ssm/types.rb', line 13614

class MaintenanceWindowTask < Struct.new(
  :window_id,
  :window_task_id,
  :task_arn,
  :type,
  :targets,
  :task_parameters,
  :priority,
  :logging_info,
  :service_role_arn,
  :max_concurrency,
  :max_errors,
  :name,
  :description)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#window_task_idString

The task ID.

Returns:

  • (String)

13614
13615
13616
13617
13618
13619
13620
13621
13622
13623
13624
13625
13626
13627
13628
13629
13630
# File 'lib/aws-sdk-ssm/types.rb', line 13614

class MaintenanceWindowTask < Struct.new(
  :window_id,
  :window_task_id,
  :task_arn,
  :type,
  :targets,
  :task_parameters,
  :priority,
  :logging_info,
  :service_role_arn,
  :max_concurrency,
  :max_errors,
  :name,
  :description)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end