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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cluster ⇒ String

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) 


9528
9529
9530
9531
9532
9533
9534
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 9528

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

#reason ⇒ String

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

Returns:

  • (String) 


9528
9529
9530
9531
9532
9533
9534
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 9528

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

#task ⇒ String

The task ID of the task to stop.

Returns:

  • (String) 


9528
9529
9530
9531
9532
9533
9534
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 9528

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