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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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",
}

Constant Summary collapse

SENSITIVE =
[]

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)

9786
9787
9788
9789
9790
9791
9792
# File 'lib/aws-sdk-ecs/types.rb', line 9786

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

#reasonString

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)

9786
9787
9788
9789
9790
9791
9792
# File 'lib/aws-sdk-ecs/types.rb', line 9786

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

#taskString

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

Returns:

  • (String)

9786
9787
9788
9789
9790
9791
9792
# File 'lib/aws-sdk-ecs/types.rb', line 9786

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