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

Inherits:

Struct

• Object
• Struct
• Aws::ECS::Types::StopTaskRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ecs/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cluster ⇒ String

  The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop.

• #reason ⇒ String

  An optional message specified when a task is stopped.

• #task ⇒ String

  The task ID of the task to stop.

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)

# File 'lib/aws-sdk-ecs/types.rb', line 9416

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)

# File 'lib/aws-sdk-ecs/types.rb', line 9416

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

#task ⇒ String

The task ID of the task to stop.

Returns:

• (String)

# File 'lib/aws-sdk-ecs/types.rb', line 9416

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