Class: Ansible::Ruby::Modules::Ecs_taskdefinition

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/amazon/ecs_taskdefinition.rb

Overview

Registers or deregisters task definitions in the Amazon Web Services (AWS) EC2 Container Service (ECS)

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#arn ⇒ Object?

Returns The arn of the task description to delete.

Returns:

  • (Object, nil) —

    The arn of the task description to delete



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ecs_taskdefinition.rb', line 16

attribute :arn

#containers ⇒ Array<Hash>, ...

Returns A list of containers definitions.

Returns:

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

    A list of containers definitions



29
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ecs_taskdefinition.rb', line 29

attribute :containers

#cpu ⇒ Integer?

Returns The number of cpu units used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of [256, 512, 1024, 2048, 4096].

Returns:

  • (Integer, nil) —

    The number of cpu units used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of [256, 512, 1024, 2048, 4096]



51
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ecs_taskdefinition.rb', line 51

attribute :cpu

#execution_role_arn ⇒ Object?

Returns The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.

Returns:

  • (Object, nil) —

    The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.



40
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ecs_taskdefinition.rb', line 40

attribute :execution_role_arn

#family ⇒ String?

Returns A Name that would be given to the task definition.

Returns:

  • (String, nil) —

    A Name that would be given to the task definition



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

attribute :family

#force_create ⇒ Object?

Returns Always create new task definition.

Returns:

  • (Object, nil) —

    Always create new task definition



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

attribute :force_create

#launch_type ⇒ :EC2, ...

Returns The launch type on which to run your task.

Returns:

  • (:EC2, :FARGATE, nil) —

    The launch type on which to run your task



47
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ecs_taskdefinition.rb', line 47

attribute :launch_type

#memory ⇒ String?

Returns The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and is limited by the cpu.

Returns:

  • (String, nil) —

    The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and is limited by the cpu



55
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ecs_taskdefinition.rb', line 55

attribute :memory

#network_mode ⇒ :bridge, ...

Returns The Docker networking mode to use for the containers in the task.,C(awsvpc) mode was added in Ansible 2.5.

Returns:

  • (:bridge, :host, :none, :awsvpc, nil) —

    The Docker networking mode to use for the containers in the task.,C(awsvpc) mode was added in Ansible 2.5



33
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ecs_taskdefinition.rb', line 33

attribute :network_mode

#revision ⇒ Object?

Returns A revision number for the task definition.

Returns:

  • (Object, nil) —

    A revision number for the task definition



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

attribute :revision

#state ⇒ :present, :absent

Returns State whether the task definition should exist or be deleted.

Returns:

  • (:present, :absent) —

    State whether the task definition should exist or be deleted



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ecs_taskdefinition.rb', line 12

attribute :state

#task_role_arn ⇒ Object?

Returns The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.

Returns:

  • (Object, nil) —

    The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.



37
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ecs_taskdefinition.rb', line 37

attribute :task_role_arn

#volumes ⇒ Array<Hash>, ...

Returns A list of names of volumes to be attached.

Returns:

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

    A list of names of volumes to be attached



43
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ecs_taskdefinition.rb', line 43

attribute :volumes