STS Assume Role
Resumo
- Assuma uma função usando o AWS Security Token Service e obtenha credenciais temporárias.
Parâmetros
Parâmetro | Tipo | Escolhas | Valor Padrão | Comentários |
|---|---|---|---|
role_arn - required | string | | O nome de recurso da Amazon (ARN) da função que o chamador é assumindo. Veja mais em: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html#Identifiers_ARNs |
role_session_name - required | string | | Nome da sessão da função - será usado pelo CloudTrail. |
policy | string | | Política suplementar a ser usada além das políticas da função assumida. |
duration_seconds | integer | | A duração, em segundos, da sessão de função. O valor pode variar de 900 segundos (15 minutos) a 43200 segundos (12 horas). O máximo depende da configuração de duração das sessões da função do IAM. Por padrão, o valor é definido como 3600 segundos. |
external_id | string | | Um identificador exclusivo usado por terceiros para assumir uma função nas contas de seus clientes. |
mfa_serial_number | string | | Número de identificação do dispositivo MFA associado ao usuário que está fazendo a chamada AssumeRole. |
mfa_token | string | | Valor fornecido pelo dispositivo MFA, se a política de confiança da função assumida exigir MFA. |
Exemplos
# Note: Esses exemplos não definem detalhes de autenticação, consulte o guia AWS para obter detalhes.
# Assumir uma função existente (mais detalhes: https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html
- sts_assume_role:
role_arn: "arn:aws:iam::123456789012:role/someRole"
role_session_name: "someRoleSession"
register: assumed_role
Valores retornados
Chave | Tipo | Retornado quando | Descrição |
|---|---|---|---|
sts_creds | dictionary | Sempre | As credenciais de segurança temporárias, que incluem um ID de chave de acesso, uma chave de acesso secreta e um token de segurança (ou sessão). |
sts_user | dictionary | Sempre | Nome de recurso da Amazon (ARN) e o ID de função assumido. |
changed | boolean | Sempre | Verdadeiro se a obtenção das credenciais for bem-sucedida. |