ecs_service - create, terminate, start or stop a service in ecs

New in version 2.1.

Synopsis
Requirements (on host that executes module)
Options
Examples
Return Values
Notes
- Status

Synopsis

Creates or terminates ecs services.

Requirements (on host that executes module)

boto
boto3
botocore
json
python >= 2.6

Options

parameter	required	default	choices	comments
aws_access_key	no			AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. aliases: ec2_access_key, access_key
aws_secret_key	no			AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. aliases: ec2_secret_key, secret_key
client_token	no			Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
cluster	no			The name of the cluster in which the service exists
delay	no	10		The time to wait before checking that the service is available
deployment_configuration (added in 2.3)	no			Optional parameters that control the deployment_configuration; format is '{"maximum_percent":<integer>, "minimum_healthy_percent":<integer>}
desired_count	no			The count of how many instances of the service. This parameter is required when state=present
ec2_url	no			Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
load_balancers	no			The list of ELBs defined for this service
name	yes			The name of the service
placement_constraints (added in 2.4)	no			The placement constraints for the tasks in the service
placement_strategy (added in 2.4)	no			The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules per service
profile (added in 1.6)	no			Uses a boto profile. Only works with boto >= 2.24.0.
region	no			The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region aliases: aws_region, ec2_region
repeat	no	10		The number of times to check that the service is available
role	no			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.
security_token (added in 1.6)	no			AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. aliases: access_token
state	yes		present absent deleting	The desired state of the service
task_definition	no			The task definition the service will run. This parameter is required when state=present
validate_certs (added in 1.5)	no	yes	yes no	When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

Examples

# Note: These examples do not set authentication details, see the AWS Guide for details.
- ecs_service:
    state: present
    name: console-test-service
    cluster: new_cluster
    task_definition: 'new_cluster-task:1'
    desired_count: 0

# Basic provisioning example
- ecs_service:
    name: default
    state: present
    cluster: new_cluster

# Simple example to delete
- ecs_service:
    name: default
    state: absent
    cluster: new_cluster

# With custom deployment configuration (added in version 2.3), placement constraints and strategy (added in version 2.4)
- ecs_service:
    state: present
    name: test-service
    cluster: test-cluster
    task_definition: test-task-definition
    desired_count: 3
    deployment_configuration:
      minimum_healthy_percent: 75
      maximum_percent: 150
    placement_constraints:
      - type: memberOf
        expression: 'attribute:flavor==test'
    placement_strategy:
      - type: binpack
        field: memory

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name

description

returned

type

sample

ansible_facts

Facts about deleted service.

when deleting a service

complex

contains:

name	description	returned	type	sample
service	Details of deleted service in the same structure described above for service creation.	when service existed and was deleted	complex

service

Details of created service.

when creating a service

complex

contains:

name	description	returned	type
status	The valid values are ACTIVE, DRAINING, or INACTIVE.	always	string
pendingCount	The number of tasks in the cluster that are in the PENDING state.	always	int
loadBalancers	A list of load balancer objects	always	complex
placementConstraints	List of placement constraints objects	always	list of complex
desiredCount	The desired number of instantiations of the task definition to keep running on the service.	always	int
runningCount	The number of tasks in the cluster that are in the RUNNING state.	always	int
serviceName	A user-generated string used to identify the service	always	string
clusterArn	The Amazon Resource Name (ARN) of the of the cluster that hosts the service.	always	string
serviceArn	The Amazon Resource Name (ARN) that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the region of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region :012345678910 :service/my-service .	always	string
deploymentConfiguration	dictionary of deploymentConfiguration	always	complex
deployments	list of service deployments	always	list of complex
events	list of service events	always	list of complex
taskDefinition	The ARN of a task definition to use for tasks in the service.	always	string
placementStrategy	List of placement strategy objects	always	list of complex

Notes

Note

the service role specified must be assumable (i.e. have a trust relationship for the ecs service, ecs.amazonaws.com)
for details of the parameters and returns see http://boto3.readthedocs.org/en/latest/reference/services/ecs.html
An IAM role must have been previously created
If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION
Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See http://boto.readthedocs.org/en/latest/boto_config_tut.html
AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/ecs_service_module.html