community / community.aws / 0.1.2 / module / ecs_taskdefinition register a task definition in ecs | "added in version" 1.0.0 of community.aws" Authors: Mark Chance (@Java1Guy)community.aws.ecs_taskdefinition (0.1.2) — module
Install with ansible-galaxy collection install community.aws:==0.1.2
collections: - name: community.aws version: 0.1.2
Registers or deregisters task definitions in the Amazon Web Services (AWS) EC2 Container Service (ECS).
- name: Create task definition community.aws.ecs_taskdefinition: containers: - name: simple-app cpu: 10 essential: true image: "httpd:2.4" memory: 300 mountPoints: - containerPath: /usr/local/apache2/htdocs sourceVolume: my-vol portMappings: - containerPort: 80 hostPort: 80 logConfiguration: logDriver: awslogs options: awslogs-group: /ecs/test-cluster-taskdef awslogs-region: us-west-2 awslogs-stream-prefix: ecs - name: busybox command: - > /bin/sh -c "while true; do echo '<html><head><title>Amazon ECS Sample App</title></head><body><div><h1>Amazon ECS Sample App</h1><h2>Congratulations! </h2><p>Your application is now running on a container in Amazon ECS.</p>' > top; /bin/date > date ; echo '</div></body></html>' > bottom; cat top date bottom > /usr/local/apache2/htdocs/index.html ; sleep 1; done" cpu: 10 entryPoint: - sh - "-c" essential: false image: busybox memory: 200 volumesFrom: - sourceContainer: simple-app volumes: - name: my-vol family: test-cluster-taskdef state: present register: task_output
- name: Create task definition community.aws.ecs_taskdefinition: family: nginx containers: - name: nginx essential: true image: "nginx" portMappings: - containerPort: 8080 hostPort: 8080 cpu: 512 memory: 1024 state: present
- name: Create task definition community.aws.ecs_taskdefinition: family: nginx containers: - name: nginx essential: true image: "nginx" portMappings: - containerPort: 8080 hostPort: 8080 launch_type: FARGATE cpu: 512 memory: 1024 state: present network_mode: awsvpc
# Create Task Definition with Environment Variables and Secrets - name: Create task definition community.aws.ecs_taskdefinition: family: nginx containers: - name: nginx essential: true image: "nginx" environment: - name: "PORT" value: "8080" secrets: # For variables stored in Secrets Manager - name: "NGINX_HOST" valueFrom: "arn:aws:secretsmanager:us-west-2:123456789012:secret:nginx/NGINX_HOST" # For variables stored in Parameter Store - name: "API_KEY" valueFrom: "arn:aws:ssm:us-west-2:123456789012:parameter/nginx/API_KEY" launch_type: FARGATE cpu: 512 memory: 1GB state: present network_mode: awsvpc
arn: description: - The ARN of the task description to delete. required: false type: str cpu: description: - 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 C(256), C(512), C(1024), C(2048), C(4096). required: false type: str state: choices: - present - absent description: - State whether the task definition should exist or be deleted. required: true type: str family: description: - A Name that would be given to the task definition. required: false type: str memory: description: - 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. required: false 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 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: - 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 volumes: description: - A list of names of volumes to be attached. elements: dict required: false suboptions: name: description: The name of the volume. required: true type: str type: list revision: description: - A revision number for the task definition. required: false type: int 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 containers: description: - A list of containers definitions. elements: str required: false type: list launch_type: choices: - EC2 - FARGATE description: - The launch type on which to run your task. required: false type: str force_create: description: - Always create new task definition. required: false type: bool network_mode: choices: - default - bridge - host - none - awsvpc default: bridge description: - The Docker networking mode to use for the containers in the task. - C(awsvpc) mode was added in Ansible 2.5 - Windows containers must use I(network_mode=default), which will utilize docker NAT networking. - Setting I(network_mode=default) for a Linux container will use bridge mode. required: false type: str aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - Not used by boto 2 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 task_role_arn: description: - 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. required: false type: str aws_access_key: aliases: - ec2_access_key - access_key description: - C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(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: - C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(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 security_token: aliases: - aws_security_token - access_token description: - C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN) or C(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 communication with the AWS APIs. type: bool execution_role_arn: description: - The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume. required: false type: str 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
taskdefinition: description: a reflection of the input parameters returned: always type: dict