Parameter |
Choices/Defaults |
Comments |
aws_access_key
|
|
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
|
|
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
|
|
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
|
cluster
|
|
The name of the cluster in which the service exists
|
delay
|
Default:
10
|
The time to wait before checking that the service is available
|
deployment_configuration
(added in 2.3) |
|
Optional parameters that control the deployment_configuration; format is '{"maximum_percent":<integer>, "minimum_healthy_percent":<integer>}
|
desired_count
|
|
The count of how many instances of the service. This parameter is required when state=present
|
ec2_url
|
|
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.
|
launch_type
(added in 2.7) |
|
The launch type on which to run your service
|
load_balancers
|
|
The list of ELBs defined for this service
|
name
required |
|
The name of the service
|
network_configuration
|
|
network configuration of the service. Only applicable for task definitions created with awsvpc network_mode.
assign_public_ip requires botocore >= 1.8.4
|
|
subnets
(added in 2.6) |
|
A list of subnet IDs to associate with the task
|
|
security_groups
(added in 2.6) |
|
A list of security group names or group IDs to associate with the task
|
|
assign_public_ip
bool
(added in 2.7) |
|
Whether the task's elastic network interface receives a public IP address. This option requires botocore >= 1.8.4.
|
placement_constraints
(added in 2.4) |
|
The placement constraints for the tasks in the service
|
placement_strategy
(added in 2.4) |
|
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) |
|
Uses a boto profile. Only works with boto >= 2.24.0.
|
region
|
|
aliases: aws_region, ec2_region
|
repeat
|
Default:
10
|
The number of times to check that the service is available
|
role
|
|
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`.
|
security_token
(added in 1.6) |
|
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
required |
Choices:
- present
- absent
- deleting
|
The desired state of the service
|
task_definition
|
|
The task definition the service will run. This parameter is required when state=present
|
validate_certs
bool
(added in 1.5) |
|
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
|