community / community.aws / 4.3.0 / module / ecs_service Create, terminate, start or stop a service in ECS | "added in version" 1.0.0 of community.aws" Authors: Mark Chance (@Java1Guy), Darek Kaczynski (@kaczynskid), Stephane Maarek (@simplesteph), Zac Blazic (@zacblazic)community.aws.ecs_service (4.3.0) — module
Install with ansible-galaxy collection install community.aws:==4.3.0
collections: - name: community.aws version: 4.3.0
Creates or terminates ECS services.
# Note: These examples do not set authentication details, see the AWS Guide for details. # Basic provisioning example - community.aws.ecs_service: state: present name: console-test-service cluster: new_cluster task_definition: 'new_cluster-task:1' desired_count: 0
- name: create ECS service on VPC network community.aws.ecs_service: state: present name: console-test-service cluster: new_cluster task_definition: 'new_cluster-task:1' desired_count: 0 network_configuration: subnets: - subnet-abcd1234 security_groups: - sg-aaaa1111 - my_security_group
# Simple example to delete - community.aws.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) - community.aws.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
# With deployment circuit breaker (added in version 4.0) - community.aws.ecs_service: state: present name: test-service cluster: test-cluster task_definition: test-task-definition desired_count: 3 deployment_configuration: deployment_circuit_breaker: enable: True rollback: True
# With capacity_provider_strategy (added in version 4.0) - community.aws.ecs_service: state: present name: test-service cluster: test-cluster task_definition: test-task-definition desired_count: 1 capacity_provider_strategy: - capacity_provider: test-capacity-provider-1 weight: 1 base: 0
# With tags and tag propagation - community.aws.ecs_service: state: present name: tags-test-service cluster: new_cluster task_definition: 'new_cluster-task:1' desired_count: 1 tags: Firstname: jane lastName: doe propagate_tags: SERVICE
name: aliases: - service description: - The name of the service. required: true type: str role: description: - 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 C(awsvpc). required: false type: str tags: description: - A dictionary of tags to add or remove from the resource. required: false type: dict version_added: 4.1.0 version_added_collection: community.aws wait: default: false description: - Whether or not to wait for the service to be inactive. - Waits only when I(state) is C(absent). type: bool version_added: 4.1.0 version_added_collection: community.aws delay: default: 10 description: - The time to wait before checking that the service is available. required: false type: int state: choices: - present - absent - deleting description: - The desired state of the service. required: true type: str region: aliases: - aws_region - ec2_region description: - 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) type: str repeat: default: 10 description: - The number of times to check that the service is available. required: false type: int cluster: default: default description: - The name of the cluster in which the service exists. - If not specified, the cluster name will be C(default). required: false type: str ec2_url: aliases: - aws_endpoint_url - endpoint_url description: - 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. type: str profile: aliases: - aws_profile description: - Uses a boto profile. Only works with boto >= 2.24.0. - Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token) and support for passing them at the same time as I(profile) has been deprecated. - I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually exclusive with I(profile) after 2022-06-01. type: str aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config). - Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto) for more boto configuration. type: dict launch_type: choices: - EC2 - FARGATE description: - The launch type on which to run your service. required: false type: str client_token: description: - Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed. required: false type: str aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - Only used for boto3 based modules. - 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied from the controller if not run locally.' type: path desired_count: description: - The count of how many instances of the service. - This parameter is required when I(state=present). required: false type: int aws_access_key: aliases: - ec2_access_key - access_key description: - 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. - If I(profile) is set this parameter is ignored. - Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str aws_secret_key: aliases: - ec2_secret_key - secret_key description: - 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. - If I(profile) is set this parameter is ignored. - Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str force_deletion: default: false description: - Forcibly delete the service. Required when deleting a service with >0 scale, or no target group. type: bool version_added: 2.1.0 version_added_collection: community.aws load_balancers: description: - The list of ELBs defined for this service. - Load balancers for an existing service cannot be updated, and it is an error to do so. - When the deployment controller is CODE_DEPLOY changes to this value are simply ignored, and do not cause an error. elements: dict required: false type: list propagate_tags: choices: - TASK_DEFINITION - SERVICE description: - Propagate tags from ECS task defintition or ECS service to ECS task. required: false type: str version_added: 4.1.0 version_added_collection: community.aws security_token: aliases: - aws_security_token - access_token description: - AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(security_token) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str validate_certs: default: true description: - When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. type: bool task_definition: description: - The task definition the service will run. - This parameter is required when I(state=present). - This parameter is ignored when updating a service with a C(CODE_DEPLOY) deployment controller in which case the task definition is managed by Code Pipeline and cannot be updated. required: false type: str platform_version: description: - Numeric part of platform version or LATEST - See U(https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) for more details. required: false type: str version_added: 1.5.0 version_added_collection: community.aws placement_strategy: description: - The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules per service. elements: dict required: false suboptions: field: description: The field to apply the placement strategy against. type: str type: description: The type of placement strategy. type: str type: list service_registries: description: - Describes service discovery registries this service will register with. elements: dict required: false suboptions: arn: description: - Service discovery registry ARN. type: str container_name: description: - Container name for service discovery registration. type: str container_port: description: - Container port for service discovery registration. type: int type: list scheduling_strategy: choices: - DAEMON - REPLICA description: - The scheduling strategy. - Defaults to C(REPLICA) if not given to preserve previous behavior. required: false type: str force_new_deployment: default: false description: - Force deployment of service even if there are no changes. required: false type: bool deployment_controller: description: - The deployment controller to use for the service. If no deploymenet controller is specified, the ECS controller is used. required: false suboptions: type: choices: - ECS - CODE_DEPLOY - EXTERNAL description: The deployment controller type to use. type: str type: dict version_added: 4.1.0 version_added_collection: community.aws network_configuration: description: - Network configuration of the service. Only applicable for task definitions created with I(network_mode=awsvpc). suboptions: assign_public_ip: description: - Whether the task's elastic network interface receives a public IP address. type: bool security_groups: description: - A list of security group names or group IDs to associate with the task. elements: str type: list subnets: description: - A list of subnet IDs to associate with the task. elements: str type: list type: dict placement_constraints: description: - The placement constraints for the tasks in the service. - See U(https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PlacementConstraint.html) for more details. elements: dict required: false suboptions: expression: description: A cluster query language expression to apply to the constraint. required: false type: str type: description: The type of constraint. type: str type: list deployment_configuration: description: - Optional parameters that control the deployment_configuration. - Format is '{"maximum_percent":<integer>, "minimum_healthy_percent":<integer>} required: false suboptions: deployment_circuit_breaker: description: The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. suboptions: enable: description: If enabled, a service deployment will transition to a failed state and stop launching new tasks. type: bool rollback: description: If enabled, ECS will roll back your service to the last completed deployment after a failure. type: bool type: dict maximum_percent: description: Upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment. type: int minimum_healthy_percent: description: A lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment. type: int type: dict capacity_provider_strategy: description: - The capacity provider strategy to use with your service. You can specify a maximum of 6 providers per strategy. elements: dict required: false suboptions: base: description: - How many tasks, at a minimum, should use the specified provider. type: int capacity_provider: description: - Name of capacity provider. type: str weight: description: - The relative percentage of the total number of launched tasks that should use the specified provider. type: int type: list version_added: 4.0.0 version_added_collection: community.aws debug_botocore_endpoint_logs: default: 'no' description: - Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used. type: bool health_check_grace_period_seconds: description: - Seconds to wait before health checking the freshly added/updated services. required: false type: int
ansible_facts: contains: service: contains: clusterArn: description: The Amazon Resource Name (ARN) of the of the cluster that hosts the service. returned: always type: str deploymentConfiguration: contains: deploymentCircuitBreaker: contains: enable: description: The state of the circuit breaker feature. returned: always type: bool rollback: description: The state of the rollback feature of the circuit breaker. returned: always type: bool description: dictionary of deploymentCircuitBreaker returned: always type: complex maximumPercent: description: maximumPercent param returned: always type: int minimumHealthyPercent: description: minimumHealthyPercent param returned: always type: int description: dictionary of deploymentConfiguration returned: always type: complex deployments: description: list of service deployments elements: dict returned: always type: list desiredCount: description: The desired number of instantiations of the task definition to keep running on the service. returned: always type: int events: description: list of service events elements: dict returned: always type: list loadBalancers: contains: containerName: description: The name of the container to associate with the load balancer. returned: always type: str containerPort: description: The port on the container to associate with the load balancer. returned: always type: int loadBalancerName: description: the name returned: always type: str description: A list of load balancer objects returned: always type: complex pendingCount: description: The number of tasks in the cluster that are in the PENDING state. returned: always type: int placementConstraints: contains: expression: description: A cluster query language expression to apply to the constraint. Note you cannot specify an expression if the constraint type is distinctInstance. returned: always type: str type: description: The type of constraint. Valid values are distinctInstance and memberOf. returned: always type: str description: List of placement constraints objects elements: dict returned: always type: list placementStrategy: contains: field: description: The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are CPU and MEMORY. returned: always type: str type: description: The type of placement strategy. Valid values are random, spread and binpack. returned: always type: str description: List of placement strategy objects elements: dict returned: always type: list propagateTags: description: The type of tag propagation applied to the resource returned: always type: str runningCount: description: The number of tasks in the cluster that are in the RUNNING state. returned: always type: int serviceArn: description: 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 . returned: always type: str serviceName: description: A user-generated string used to identify the service returned: always type: str status: description: The valid values are ACTIVE, DRAINING, or INACTIVE. returned: always type: str tags: description: The tags applied to this resource. elements: dict returned: when tags found type: list taskDefinition: description: The ARN of a task definition to use for tasks in the service. returned: always type: str description: Details of deleted service. returned: when service existed and was deleted type: complex description: Facts about deleted service. returned: when deleting a service type: complex service: contains: capacityProviderStrategy: contains: base: description: How many tasks, at a minimum, should use the specified provider. returned: always type: int capacityProvider: description: Name of capacity provider. returned: always type: str weight: description: The relative percentage of the total number of launched tasks that should use the specified provider. returned: always type: int description: The capacity provider strategy to use with your service. returned: always type: complex version_added: 4.0.0 version_added_collection: community.aws clusterArn: description: The Amazon Resource Name (ARN) of the of the cluster that hosts the service. returned: always type: str deploymentConfiguration: contains: deploymentCircuitBreaker: contains: enable: description: The state of the circuit breaker feature. returned: always type: bool rollback: description: The state of the rollback feature of the circuit breaker. returned: always type: bool description: dictionary of deploymentCircuitBreaker returned: always type: complex maximumPercent: description: maximumPercent param returned: always type: int minimumHealthyPercent: description: minimumHealthyPercent param returned: always type: int description: dictionary of deploymentConfiguration returned: always type: complex deployments: description: list of service deployments elements: dict returned: always type: list desiredCount: description: The desired number of instantiations of the task definition to keep running on the service. returned: always type: int events: description: list of service events elements: dict returned: always type: list loadBalancers: contains: containerName: description: The name of the container to associate with the load balancer. returned: always type: str containerPort: description: The port on the container to associate with the load balancer. returned: always type: int loadBalancerName: description: the name returned: always type: str description: A list of load balancer objects returned: always type: complex pendingCount: description: The number of tasks in the cluster that are in the PENDING state. returned: always type: int placementConstraints: contains: expression: description: A cluster query language expression to apply to the constraint. Note you cannot specify an expression if the constraint type is distinctInstance. returned: always type: str type: description: The type of constraint. Valid values are distinctInstance and memberOf. returned: always type: str description: List of placement constraints objects elements: dict returned: always type: list placementStrategy: contains: field: description: The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are CPU and MEMORY. returned: always type: str type: description: The type of placement strategy. Valid values are random, spread and binpack. returned: always type: str description: List of placement strategy objects elements: dict returned: always type: list propagateTags: description: The type of tag propagation applied to the resource. returned: always type: str runningCount: description: The number of tasks in the cluster that are in the RUNNING state. returned: always type: int serviceArn: description: 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 . returned: always type: str serviceName: description: A user-generated string used to identify the service returned: always type: str status: description: The valid values are ACTIVE, DRAINING, or INACTIVE. returned: always type: str tags: description: The tags applied to this resource. returned: success type: dict taskDefinition: description: The ARN of a task definition to use for tasks in the service. returned: always type: str description: Details of created service. returned: when creating a service type: complex