IAM User
Resumo
- Um módulo para gerenciar usuários do AWS IAM.
- O módulo não gerencia grupos aos quais os usuários pertencem, as associações de grupos podem ser gerenciadas usando iam_group.
Parâmetro | Tipo | Escolhas | Valor Padrão | Comentários |
|---|---|---|---|
name - required | string | | O nome do usuário a ser criado. |
password | string | | A senha a ser aplicada ao usuário. |
profile | string | | O uso do profile substituirá aws_access_key , aws_secret_key e security_token e o suporte para passá-los ao mesmo tempo em que o profile foi descontinuado. |
purge_policies | boolean | Escolhas:
| Quando purge_policies=true , quaisquer políticas gerenciadas não listadas em managed_policies serão desanexadas. |
purge_tags | boolean | Escolhas:
| Remova as tags não listadas nas tags quando as tags forem especificadas. |
remove_password | boolean | Escolhas:
| Opção para excluir senhas de login do usuário. Este campo é mutuamente exclusivo para senha. |
security_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:
| Crie ou remova o usuário do IAM. |
tags | dictionary | | Tag dict para aplicar ao usuário. |
update_password | string | Escolhas:
| Quando atualizar as senhas dos usuários. update_password=always garantirá que a senha seja definida como password. update_password=on_create só definirá a senha para usuários recém-criados. |
validate_certs | boolean | Escolhas:
| Quando definido como “false”, os certificados SSL não serão validados para comunicação com as APIs da AWS. |
wait | boolean | Escolhas:
| Quando wait=True , o módulo aguardará até wait_timeout segundos pela criação do usuário do IAM antes de retornar. |
wait_timeout | integer | Default: 120 | Quanto tempo (em segundos) aguardar a conclusão da criação/atualizações. |
Notas
- Se os parâmetros não forem definidos no módulo, as seguintes variáveis de ambiente podem ser usadas em ordem decrescente de precedência:
- 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
- Quando nenhuma credencial é fornecida explicitamente, o AWS SDK (boto3) que o Ansible usa retornará aos seus arquivos de configuração (normalmente ~/.aws/credentials). Consulte https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html para obter mais informações.
- Módulos baseados no AWS SDK original (boto) podem ler sua configuração padrão de arquivos diferentes. Consulte https://boto.readthedocs.io/en/latest/boto_config_tut.html para obter mais informações.
- AWS_REGION ou EC2_REGION pode ser normalmente usado para especificar a região da AWS, quando necessário, mas isso também pode ser definido nos arquivos de configuração.
Exemplos
# Observação: esses exemplos não definem detalhes de autenticação, consulte o AWS Guide para obter detalhes.
# Nota: Este módulo não permite o gerenciamento de grupos aos quais os usuários pertencem.
# Grupos devem gerenciar seus membros diretamente usando `iam_group`,
# pois os usuários pertencem a eles.
- name: Create a user
iam_user:
name: testuser1
state: present
- name: Create a user with a password
iam_user:
name: testuser1
password: SomeSecurePassword
state: present
- name: Create a user and attach a managed policy using its ARN
iam_user:
name: testuser1
managed_policies:
- arn:aws:iam::aws:policy/AmazonSNSFullAccess
state: present
- name: Remove all managed policies from an existing user with an empty list
iam_user:
name: testuser1
state: present
purge_policies: true
- name: Create user with tags
iam_user:
name: testuser1
state: present
tags:
Env: Prod
- name: Delete the user
iam_user:
name: testuser1
state: absent
Valores de retorno
Chave | Tipo | Retornado quando | Descrição |
|---|---|---|---|
user | complex | sucesso | dicionário contendo todas as informações do usuário |
arn | string | se o usuário existir | o ARN do usuário |
Criar Data | string | se o usuário existir | o usuário datetime foi criado |
password_last_used | string | se a senha foi usada pelo menos uma vez | a última data e hora em que a senha foi usada pelo usuário |
path | string | se o usuário existir | o caminho para o usuário |
Tag | string | se o usuário existir | Marcas de usuário. |
user_id | string | se o usuário existir | o ID de usuário único |
user_name | string | se o usuário existir | o nome de usuário |