Class: Ansible::Ruby::Modules::Ecs_task

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Ecs_task

Defined in:

lib/ansible/ruby/modules/generated/extras/cloud/amazon/ecs_task.rb

Overview

Creates or deletes instances of task definitions.

Instance Method Summary

• #cluster ⇒ String^?

  The name of the cluster to run the task on.

• #container_instances ⇒ Array<String>, ...

  The list of container instances on which to deploy the task.

• #count ⇒ Integer^?

  How many new instances to start.

• #operation ⇒ :run, ...

  Which task operation to execute.

• #overrides ⇒ Object^?

  A dictionary of values to pass to the new instances.

• #started_by ⇒ String^?

  A value showing who or what started the task (for informational purposes).

• #task ⇒ String^?

  The task to stop.

• #task_definition ⇒ String^?

  The task definition to start or run.

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#cluster ⇒ String^?

Returns The name of the cluster to run the task on.

Returns:

• (String, nil) —

  The name of the cluster to run the task on

# File 'lib/ansible/ruby/modules/generated/extras/cloud/amazon/ecs_task.rb', line 15

attribute :cluster

#container_instances ⇒ Array<String>, ...

Returns The list of container instances on which to deploy the task.

Returns:

• (Array<String>, String, nil) —

  The list of container instances on which to deploy the task

# File 'lib/ansible/ruby/modules/generated/extras/cloud/amazon/ecs_task.rb', line 34

attribute :container_instances

#count ⇒ Integer^?

Returns How many new instances to start.

Returns:

• (Integer, nil) —

  How many new instances to start

# File 'lib/ansible/ruby/modules/generated/extras/cloud/amazon/ecs_task.rb', line 26

attribute :count

#operation ⇒ :run, ...

Returns Which task operation to execute.

Returns:

• (:run, :start, :stop) —

  Which task operation to execute

# File 'lib/ansible/ruby/modules/generated/extras/cloud/amazon/ecs_task.rb', line 11

attribute :operation

#overrides ⇒ Object^?

Returns A dictionary of values to pass to the new instances.

Returns:

• (Object, nil) —

  A dictionary of values to pass to the new instances

# File 'lib/ansible/ruby/modules/generated/extras/cloud/amazon/ecs_task.rb', line 23

attribute :overrides

#started_by ⇒ String^?

Returns A value showing who or what started the task (for informational purposes).

Returns:

• (String, nil) —

  A value showing who or what started the task (for informational purposes)

# File 'lib/ansible/ruby/modules/generated/extras/cloud/amazon/ecs_task.rb', line 38

attribute :started_by

#task ⇒ String^?

Returns The task to stop.

Returns:

• (String, nil) —

  The task to stop

# File 'lib/ansible/ruby/modules/generated/extras/cloud/amazon/ecs_task.rb', line 30

attribute :task

#task_definition ⇒ String^?

Returns The task definition to start or run.

Returns:

• (String, nil) —

  The task definition to start or run

# File 'lib/ansible/ruby/modules/generated/extras/cloud/amazon/ecs_task.rb', line 19

attribute :task_definition