Class: Ansible::Ruby::Modules::Ecs_service

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

Overview

Creates or terminates ecs services.

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

#client_token ⇒ Object?

Returns Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.

Returns:

  • (Object, nil) —

    Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.



35
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ecs_service.rb', line 35

attribute :client_token

#cluster ⇒ String?

Returns The name of the cluster in which the service exists.

Returns:

  • (String, nil) —

    The name of the cluster in which the service exists



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ecs_service.rb', line 20

attribute :cluster

#delay ⇒ Integer?

Returns The time to wait before checking that the service is available.

Returns:

  • (Integer, nil) —

    The time to wait before checking that the service is available



41
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ecs_service.rb', line 41

attribute :delay

#deployment_configuration ⇒ Hash?

Returns Optional parameters that control the deployment_configuration; format is ‘“minimum_healthy_percent”:<integer>.

Returns:

  • (Hash, nil) —

    Optional parameters that control the deployment_configuration; format is ‘“minimum_healthy_percent”:<integer>



49
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ecs_service.rb', line 49

attribute :deployment_configuration

#desired_count ⇒ Integer?

Returns The count of how many instances of the service. This parameter is required when state=present.

Returns:

  • (Integer, nil) —

    The count of how many instances of the service. This parameter is required when state=present



31
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ecs_service.rb', line 31

attribute :desired_count

#launch_type ⇒ :EC2, ...

Returns The launch type on which to run your service.

Returns:

  • (:EC2, :FARGATE, nil) —

    The launch type on which to run your service



65
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ecs_service.rb', line 65

attribute :launch_type

#load_balancers ⇒ Object?

Returns The list of ELBs defined for this service.

Returns:

  • (Object, nil) —

    The list of ELBs defined for this service



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ecs_service.rb', line 28

attribute :load_balancers

#name ⇒ String

Returns The name of the service.

Returns:

  • (String) —

    The name of the service



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

attribute :name

#network_configuration ⇒ Hash?

Returns network configuration of the service. Only applicable for task definitions created with C(awsvpc) I(network_mode).,assign_public_ip requires botocore >= 1.8.4.

Returns:

  • (Hash, nil) —

    network configuration of the service. Only applicable for task definitions created with C(awsvpc) I(network_mode).,assign_public_ip requires botocore >= 1.8.4



61
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ecs_service.rb', line 61

attribute :network_configuration

#placement_constraints ⇒ Array<Hash>, ...

Returns The placement constraints for the tasks in the service.

Returns:

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

    The placement constraints for the tasks in the service



53
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ecs_service.rb', line 53

attribute :placement_constraints

#placement_strategy ⇒ Array<Hash>, ...

Returns The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules per service.

Returns:

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

    The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules per service



57
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ecs_service.rb', line 57

attribute :placement_strategy

#repeat ⇒ Integer?

Returns The number of times to check that the service is available.

Returns:

  • (Integer, nil) —

    The number of times to check that the service is available



45
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ecs_service.rb', line 45

attribute :repeat

#role ⇒ Object?

Returns The name or full Amazon Resource Name (ARN) of the IAM role that allows your Amazon ECS container agent to make calls to your load balancer on your behalf. This parameter is only required if you are using a load balancer with your service, in a network mode other than ‘awsvpc`.

Returns:

  • (Object, nil) —

    The name or full Amazon Resource Name (ARN) of the IAM role that allows your Amazon ECS container agent to make calls to your load balancer on your behalf. This parameter is only required if you are using a load balancer with your service, in a network mode other than ‘awsvpc`.



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

attribute :role

#state ⇒ :present, ...

Returns The desired state of the service.

Returns:

  • (:present, :absent, :deleting) —

    The desired state of the service



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

attribute :state

#task_definition ⇒ String?

Returns The task definition the service will run. This parameter is required when state=present.

Returns:

  • (String, nil) —

    The task definition the service will run. This parameter is required when state=present



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ecs_service.rb', line 24

attribute :task_definition