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

Class: Aws::ECS::Types::StopTaskRequest

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

Overview

Note:

When making an API call, you may pass StopTaskRequest data as a hash:

{
  cluster: "String",
  task: "String", # required
  reason: "String",
}

Instance Attribute Summary collapse

Instance Attribute Details

#clusterString

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.

Returns:

  • (String)


3546
3547
3548
3549
3550
3551
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3546

class StopTaskRequest < Struct.new(
  :cluster,
  :task,
  :reason)
  include Aws::Structure
end

#reasonString

An optional message specified when a task is stopped. For example, if you are using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message will appear in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.

Returns:

  • (String)


3546
3547
3548
3549
3550
3551
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3546

class StopTaskRequest < Struct.new(
  :cluster,
  :task,
  :reason)
  include Aws::Structure
end

#taskString

The task ID or full Amazon Resource Name (ARN) entry of the task to stop.

Returns:

  • (String)


3546
3547
3548
3549
3550
3551
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3546

class StopTaskRequest < Struct.new(
  :cluster,
  :task,
  :reason)
  include Aws::Structure
end