IAM Access Key
Resumo
- Gerencie as chaves de acesso do usuário do IAM AWS.
Parâmetros
Parâmetro | Tipo | Escolhas | Valor Padrão | Comentários |
|---|---|---|---|
user_name - required aliases: ['username'] | string | | Nome do usuário do IAM ao qual a chave pertence. |
id | string | | ID da chave de acesso. Necessário quando (state=absent). Mutuamente exclusivo com (rotate_keys). |
state | string | Escolhas: - present (default) - absent | Crie ou remova a chave de acesso. Quando (state=present) e (id) não estiverem definidos, uma nova chave será criada. |
active aliases: ['enabled'] | boolean | Escolhas: - true (default) - false | Se a chave deve ser habilitada ou desabilitada. O padrão é (true) ao criar uma nova chave. |
rotate_keys | boolean | Escolhas: - true - false (default) | Quando já houver 2 chaves de acesso anexadas ao usuário do IAM, a chave mais antiga será removida e uma nova chave será criada. Ignorado se (state=absent). Mutuamente exclusivo com (id). |
Exemplos
# Observação: esses exemplos não definem detalhes de autenticação, consulte o AWS Guide para obter detalhes.
# Exemplo: Criar uma nova chave de acesso
- iam_access_key:
user_name: example_user
state: present
# Exemplo: Excluir a access_key
- iam_access_key:
name: example_user
access_key_id: AKIA1EXAMPLE1EXAMPLE
state: absent
Valores retornados
Chave | Tipo | Retornado quando | Descrição |
|---|---|---|---|
access_key | complex | Quando a chave existe | Um dicionário contendo todas as informações da chave de acesso. |
secret_access_key | string | Quando uma nova chave é criada. | A chave de acesso secreta. Uma chave de acesso secreta é o equivalente a uma senha que não pode ser alterada e, como tal, deve ser considerada um dado sensível. As chaves de acesso secretas só podem ser acessadas no momento da criação. |
deleted_access_key_id | string | Quando uma chave foi excluída durante a rotação das chaves de acesso | A chave de acesso excluída durante a rotação. |
Subcampos da chave de retorno access_key
Chave | Tipo | Retornado quando | Descrição |
|---|---|---|---|
access_key_id | string | Sucesso | O ID da chave de acesso. |
create_date | string | Sucesso | A data e hora, no formato de data e hora ISO 8601, quando a chave de acesso foi criada. |
user_name | string | Sucesso | Nome do usuário do IAM ao qual a chave está anexada. |
status | string | Sucesso | Estado da chave. (Ativo) significa que pode ser usado. (Inativo) significa que não pode ser usado. |