AWS Secret

6 min

Resumo

Cria, faz update ou deleta secrets no storage da AWS Manager.

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 registrador botocore.endpoint para analisar as chamadas de API "resource:action" exclusivas (em vez do total): feitas durante uma tarefa, enviando o conjunto para a chave resource_actions nos resultados da tarefa.
description	string		Descrição do security group. Requerido quando o state está presente.
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.
kms_key_id			Especifica o ARN ou alias do AWS KMS master key do cliente (CMK) para ser usado para encripitar os valores secret_string ou a secret_binary nas versões armazenadas neste segredo.
name	string		Nome para o segredo que você está criando.
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.
recovery_window	interger	Default: 30	Somente usado se o estado for absent. Especifica o número de dias que o Secrets Manager espera antes de poder deletar o segredo. Se setado para 0, a deleção é forçada sem recuperação.
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
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.
rotation_interval	insterger	Default: 30	Especifica o número de dias entre a agenda automatica de rotações do segredo.
rotation_lambda	string		Especifica o ARN da função Lambda que pode rotacionar o segredo.
secret	string	Default: ""	Especifica a string ou dado binário que você pode encriptar e armazenar na versão nova do segredo
secret_type	string	Escolhas: - binary - string	Especifica o tipo de dados que você pode encriptar
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.
tags	dictionary		Um dict de uma ou mais tags para coloar no security group.
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.
vpc_id	string		Id do VPC para crear dentro do grupo

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: Add string to AWS Secrets Manager
  community.aws.aws_secret:
    name: 'test_secret_string'
    state: present
    secret_type: 'string'
    secret: "{{ super_secret_string }}"

- name: remove string from AWS Secrets Manager
  community.aws.aws_secret:
    name: 'test_secret_string'
    state: absent
    secret_type: 'string'
    secret: "{{ super_secret_string }}"

Valores Retornados

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
secret	complexo	sempre	Informação secreta

Subcampos de secret

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
arn	string	sempre	O ARN da informação
last_accessed_date	string	sempre	A data que o segredo foi acessado pela última vez
last_changed_date	string	sempre	A data que o segredo foi alterado pela última vez
name	string	sempre	Nome do segredo
rotation_enabled	boolean	sempre	O status de rotação do segredo
version_ids_to_stages	dictionary	sempre	Provê a id da versão do segredo e o estágio do segredo associado