EC2 Tag

5 min

Resumo

Cria ou deleta tags ec2.

Parâmetros

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
aws_access_key aliases: ec2_access_key, access_key	string		Chave de acesso da AWS. Se não for definido, o valor da variável de ambiente AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY ou EC2_ACCESS_KEY é usado.Se o perfil for definido, este parâmetro será ignorado.Passar as opções aws_access_key e de perfil ao mesmo tempo se tornou obsoleto e as opções se tornarão mutuamente exclusivas após 01/06/2022.
aws_ca_bundle	path		A localização de um pacote CA para usar ao validar certificados SSL.Usado apenas para módulos baseados em boto3.Observação: o pacote CA é lido no lado do 'módulo' e pode precisar ser copiado explicitamente do controlador se não for executado localmente.
aws_config	dictionary		Um dicionário para modificar a configuração do botocore.Os parâmetros podem ser encontrados em https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config .Apenas a chave 'user_agent' é usada para módulos boto. Consulte http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto para obter mais configurações de boto.
aws_secret_key aliases: ec2_secret_key, secret_key	string		Chave secreta da AWS. Se não for definido, o valor da variável de ambiente AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY ou EC2_SECRET_KEY é usado.Se o perfil for definido, este parâmetro será ignorado.Passar as opções aws_secret_key e de perfil ao mesmo tempo se tornou obsoleto e as opções se tornarão mutuamente exclusivas após 01/06/2022.
debug_botocore_endpoint_logs	boolean	Escolhas: - false(default) - true	Use um logger botocore.endpoint para analisar as chamadas API "resource: action" exclusivas (ao invés do total) feitas durante uma tarefa, gerando 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 manual. A variável de ambiente ATMOSPHERE_DEBUG_BOTOCORE_LOGS também pode ser usada.
ec2_url aliases: aws_endpoint_url, endpoint_url	string		Url a ser usado para se conectar ao EC2 ou à nuvem Eucalyptus (por padrão, o módulo usará endpoints 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.
purge_tags	boolean	Escolhas: false(default) true	Se tags não especificadas devem ser removidas do recurso. Note que quando combianado com state=absent, tags especificadas com valores que não combinantes não sofrem purge.
profile aliases: aws_profile	string		Usa um perfil de boto. Funciona apenas com boto> = 2.24.0.O uso de profile sobrescreverá aws_access_key , aws_secret_key e security_token e o suporte para passá-los ao mesmo tempo que o profile foi descontinuado.aws_access_key , aws_secret_key e security_token serão mutuamente exclusivos com o perfil após 2022-06-01.
region aliases: aws_region, ec2_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/rande.html#ec2_region
resource	string		O resource id do EC2
security_token aliases: aws_security_token, access_token	string		Token de segurança AWS STS. Se não for definido, o valor da variável de ambiente AWS_SECURITY_TOKEN ou EC2_SECURITY_TOKEN será usado.Se o perfil for definido, este parâmetro será ignorado.Passar as opções security_token e profile ao mesmo tempo se tornou obsoleto e as opções serão mutuamente exclusivas após 2022-06-01.
state	string	Escolhas: - present(default) - absent - restarted - running - stopped	Crie, encerre, inicie, pare ou reinicie instâncias.Quando state = ausente , instance_ids é obrigatório.Quando state = running , state = interrompido ou state = reiniciado , tanto instance_ids quanto instance_tags são necessários.
validate_certs	boolean	Escolhas: - false - true(default)	Quando definido como "não", os certificados SSL não serão validados para versões boto> = 2.6.0.

Notas

Observação

Se os seguintes parâmetros não forem definidos no módulo, as seguintes variáveis de ambiente podem ser usadas:
- AWS_URL ou EC2_URL,
- AWS_PROFILE ou AWS_DEFAULT_PROFILE,
- AWS_ACCESS_KEY_ID ou AWS_ACCESS_KEY ou EC2_ACCESS_KEY
- AWS_SECRET_ACCESS_KEY ou AWS_SECRET_KEY ou EC2_SECRET_KEY
- AWS_SECURITY_TOKEN ou EC2_SECURITY_TOKEN
- AWS_REGION ou EC2_REGION,AWS_CA_BUNDLE
O Atmosphere usa o arquivo de configuração boto (normalmente ~/.boto) se nenhuma credencial for fornecida.
- Veja https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION ou EC2_REGION pode ser normalmente usado para especificar a região AWS, quando necessário, mas isso também pode ser configurado no arquivo de configuração do boto

Exemplos

- name: Ensure tags are present on a resource
  amazon.aws.ec2_tag:
    region: eu-west-1
    resource: vol-XXXXXX
    state: present
    tags:
      Name: ubervol
      env: prod

- name: Ensure all volumes are tagged
  amazon.aws.ec2_tag:
    region:  eu-west-1
    resource: '{{ item.id }}'
    state: present
    tags:
      Name: dbserver
      Env: production
  loop: '{{ ec2_vol.volumes }}'

- name: Remove the Env tag
  amazon.aws.ec2_tag:
    region: eu-west-1
    resource: i-xxxxxxxxxxxxxxxxx
    tags:
      Env:
    state: absent

- name: Remove the Env tag if it's currently 'development'
  amazon.aws.ec2_tag:
    region: eu-west-1
    resource: i-xxxxxxxxxxxxxxxxx
    tags:
      Env: development
    state: absent

- name: Remove all tags except for Name from an instance
  amazon.aws.ec2_tag:
    region: eu-west-1
    resource: i-xxxxxxxxxxxxxxxxx
    tags:
        Name: ''
    state: absent
    purge_tags: true

Valores Retornados

Cheve	Tipo	Retornado quando	Descrição
added_tags	dictionary	Se tags forem adicionadas	Um dict com tags que foram adicionados no resource
removed_tags	dictionary	Se tags forem adicionadas	Um dict com tags que foram removidos no resource
tags	dictionary	sempre	Um dict contendo tags de um resource