ECS Tag
Sinopse
- Cria e remove tags para recursos da AWS ECS
- Recursos são referênciados pelo nome de seus clusters
Parâmetros
Parâmetro | Tipo | Escolhas | Valor Padrão | Comentários |
|---|---|---|---|
aws_access_key aliases: ec2_access_key, access_key | string | | AWS access key. Se não for definido, o valor da variável AWS_ACCESS_KEY_ID de ambiente AWS_ACCESS_KEY ou EC2_ACCESS_KEY será usado. Se o profile for definido, este parâmetro será ignorado. |
aws_ca_bundle | path | | A localização de um CA Bundle a ser usado ao validar certificados SSL. Não usado por módulos baseados em boto 2. Observação: o CA Bundle é lido no lado do 'módulo' e pode precisar ser copiado explicitamente do controlador se não for executado localmente. |
aws_config | dictionay | | Um dicionário para modificar a configuração do botocore. Os parâmetros podem ser encontrados em https://botocore.amazonaws.com. Apenas a chave 'user_agent' é usada para módulos boto. Consulte http://boto.cloudhackers.com para obter mais configurações de boto. |
cluster_name | string | | O nome do cluster onde os recursos etão sendo taggeados. |
aws_secret_key aliases: ec2_secret_key, secret_key | string | | AWS secret key. Se não for definido, o valor da variável de ambiente AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY ou EC2_SECRET_KEY será usado. Se o profile for definido, este parâmetro será ignorado. |
debug_botocore_endpoint_logs | boolean | Escolhas:
| Use um registrador botocore.endpoint para analisar as chamadas de API exclusivas (em vez do total) “resource:action” feitas durante uma tarefa, enviando o conjunto para a chave resource_actions nos resultados da tarefa. Use o retorno de chamada aws_resource_action para gerar a lista total feita durante um playbook. |
ec2_url aliases: aws_endpoint_url, endpoint_url | string | | URL a ser usada para conectar-se ao EC2 ou à sua nuvem Eucalyptus (por padrão, o módulo usará endpoints do EC2). Ignorado para módulos onde a região é necessária. Deve ser especificado para todos os outros módulos se a região não for usada. Se não for definido, o valor da variável de ambiente EC2_URL, se houver, será usado. |
profile | string | | O uso de profile substituirá aws_access_key, aws_secret_key e security_token e o suporte para passá-los ao mesmo tempo em que profile foi obsoleto. aws_access_key, aws_secret_key e security_token serão mutuamente exclusivos com perfil após 01/06/2022. |
purge_tags | boolean | Escolhas:
| Se as tags não especificadas devem ser removidas do recurso.Observe que, quando combinado com estado=ausente, as tags especificadas com valores não correspondentes não são removidas. |
region | string | | A região da AWS a ser usada. Se não for especificado, o valor da variável de ambiente AWS_REGION ou EC2_REGION, se houver, será usado. Consulte http://docs.aws.amazon.com/general/latest/gr/rand.html#ec2_region |
resource | string | | Nome do recurso ECS. Requerido somente se resource_type=cluster. |
resource_type | string | | O tipo do recurso |
security_token aliases: aws_security_token, access_token | string | | AWS STS security token. Se não for definido, o valor da variável de ambiente AWS_SECURITY_TOKEN ou EC2_SECURITY_TOKEN será usado. |
state required | string | Escolhas:
| absent ou present são ações idempotentes que criarão ou destruirão um cluster de cache conforme necessário. rebooted reinicializará o cluster, resultando em uma interrupção momentânea. |
valid_certs | boolean | Escolhas:
| Quando definido como “não”, os certificados SSL não serão validados para comunicação com as APIs da AWS. |
Extende fragmentos da documentação do módulo aws e ec2.
Exemplos
tasks:
- name: Ensure tags are present on a resource
ecs_tag:
aws_access_key: ABVCDSIOWD123
aws_secret_key: ASDKmasdpvo21\cew.wedq12
region: "us-east-1"
cluster_name: "test"
resource_type: cluster
state: present
tags:
Name: aws:cloudformation:logical-id
env: prod
- name: Remove the Env tag
ecs_tag:
aws_access_key: ABVCDSIOWD123
aws_secret_key: ASDKmasdpvo21\cew.wedq12
region: "us-east-1"
cluster_name: test
resource_type: cluster
tags:
Name: aws:cloudformation:logical-id
state: absent
- name: Remove the Env tag if it's currently 'development'
ecs_tag:
aws_access_key: ABVCDSIOWD123
aws_secret_key: ASDKmasdpvo21\cew.wedq12
region: "us-east-1"
cluster_name: test
resource_type: cluster
tags:
Env: development
state: absent
- name: Remove all tags except for Name from a cluster
ecs_tag:
aws_access_key: ABVCDSIOWD123
aws_secret_key: ASDKmasdpvo21\cew.wedq12
region: "us-east-1"
cluster_name: test
resource_type: cluster
tags:
Name: foo
state: absent
purge_tags: true
Valores retornados
Chave | Tipo | Retorno | Descrição |
|---|---|---|---|
added_tags | dictionary | se tags foram adicionadas | Um dict de tags que foram adicionadas ao recurso |
removed_tags | dictionary | se tags foram removidas | Um dict de tags que foram removidas do recurso |
tags | dictionary | sempre | Um dict contendo as tags do recurso |