AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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",
}

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)


9139
9140
9141
9142
9143
9144
9145
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 9139

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 are 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)


9139
9140
9141
9142
9143
9144
9145
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 9139

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)


9139
9140
9141
9142
9143
9144
9145
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 9139

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