amazon.aws.kms_key_info модуль – Сбор информации о ключах AWS KMS

access_key

псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key

строка

Идентификатор ключа доступа AWS.

См. документацию AWS для получения дополнительной информации о маркерах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также могут быть использованы переменные среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY в порядке убывания приоритета.

Параметры aws_access_key и profile взаимоисключают друг друга.

Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для обеспечения согласованности с SDK AWS botocore.

Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_ACCESS_KEY устарела и будет удалена в релизе после 2024-12-01.

alias

псевдонимы: key_alias

строка

добавлен в community.aws 1.4.0

Псевдоним для ключа.

Взаимоисключает key_id и filters.

aws_ca_bundle

путь

Расположение файла с набором сертификатов CA для проверки SSL-сертификатов.

Также может быть использована переменная среды AWS_CA_BUNDLE.

aws_config

словарь

Словарь для изменения конфигурации botocore.

Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

debug_botocore_endpoint_logs

булево

Использование логгера botocore.endpoint для анализа уникальных (а не общих) "resource:action" API-вызовов, сделанных во время задачи, вывода набора в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода общего списка, выполненного во время выполнения плана.

Также может быть использована переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS.

Выбираемые значения:

• false ← (по умолчанию)
• true

endpoint_url

псевдонимы: ec2_url, aws_endpoint_url, s3_url

строка

URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws протестированы только с AWS.

Также могут быть использованы переменные среды AWS_URL или EC2_URL в порядке убывания приоритета.

Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменной среды EC2_URL устарела и будет удалена в релизе после 2024-12-01.

filters

словарь

Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра. Фильтры не поддерживаются непосредственно boto3, но поддерживаются для предоставления функциональности, аналогичной другим модулям. Доступны стандартные фильтры тегов (tag-key, tag-value и tag:tagName), а также key-id и alias.

Взаимоисключает alias и key_id.

key_id

псевдонимы: key_arn

строка

добавлен в community.aws 1.4.0

Идентификатор или ARN ключа.

Взаимоисключает alias и filters.

pending_deletion

булево

Указывает, нужно ли получить полные данные (теги, разрешения и т.д.) ключей, ожидающих удаления.

Выбираемые значения:

• false ← (по умолчанию)
• true

profile

псевдонимы: aws_profile

строка

Имя профиля AWS для аутентификации.

См. документацию AWS для получения дополнительной информации о профилях https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

Также может быть использована переменная среды AWS_PROFILE.

Параметр profile взаимоисключает параметры aws_access_key, aws_secret_key и security_token.

region

псевдонимы: aws_region, ec2_region

строка

AWS регион для использования.

Для глобальных сервисов, таких как IAM, Route53 и CloudFront, region игнорируется.

Также могут быть использованы переменные среды AWS_REGION или EC2_REGION.

См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

Псевдоним ec2_region устарел и будет удален в релизе после 2024-12-01

Поддержка переменной среды EC2_REGION устарела и будет удалена в релизе после 2024-12-01.

secret_key

aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key

string

Секретный ключ доступа AWS.

Дополнительную информацию об маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменные среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, или EC2_SECRET_KEY в порядке убывания приоритета.

Параметры secret_key и profile взаимоисключающие.

Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для соответствия SDK AWS botocore.

Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_SECRET_KEY устарела и будет удалена в релизе после 2024-12-01.

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

Маркер сеанса AWS STS для использования с временными учетными данными.

Дополнительную информацию об маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменные среды AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN в порядке убывания приоритета.

Параметры security_token и profile взаимоисключающие.

Псевдонимы aws_session_token и session_token были добавлены в релизе 3.2.0, а параметр был переименован из security_token в session_token в релизе 6.0.0.

Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменных среды EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в релизе после 2024-12-01.

validate_certs

boolean

Если установлено в false, сертификаты SSL не будут проверены для связи с API AWS.

Сильно не рекомендуется устанавливать validate_certs=false, в качестве альтернативы рассмотрите установку aws_ca_bundle вместо этого.

Варианты:

• false
• true ← (по умолчанию)

kms_keys

complex

Список ключей.

Возвращается: всегда

aliases

list / elements=string

Список псевдонимов, связанных с ключом.

Возвращается: всегда

Пример: ["aws/acm", "aws/ebs"]

aws_account_id

string

Идентификатор учетной записи AWS, которому принадлежит ключ.

Возвращается: всегда

Пример: "123456789012"

creation_date

string

Дата и время создания ключа.

Возвращается: всегда

Пример: "2017-04-18T15:12:08.551000+10:00"

customer_master_key_spec

string

Описывает тип материала ключа в ключе KMS.

Возвращается: всегда

Пример: "SYMMETRIC_DEFAULT"

deletion_date

string

добавлено в community.aws 3.3.0

Дата и время, после которого KMS удаляет этот ключ KMS.

Возвращается: когда kms_keys.key_state is PendingDeletion

Пример: "2017-04-18T15:12:08.551000+10:00"

description

string

Описание ключа.

Возвращается: всегда

Пример: "My Key for Protecting important stuff"

enable_key_rotation

boolean

Включено ли автоматическое ежегодное вращение ключей. Возвращает None, если статус вращения ключей не может быть определен.

Возвращается: всегда

Пример: false

enabled

boolean

Включен ли ключ. True, если kms_keys.key_state is Enabled.

Возвращается: всегда

Пример: false

encryption_algorithms

list / elements=string

Алгоритмы шифрования, которые поддерживает ключ KMS.

Возвращается: всегда

Пример: ["SYMMETRIC_DEFAULT"]

grants

list / elements=dictionary

Список грантов, связанных с ключом.

Возвращается: всегда

constraints

dictionary

Ограничения контекста шифрования, разрешенные грантом. См. https://docs.aws.amazon.com/kms/latest/APIReference/API_GrantConstraints.html для получения дополнительной информации

Возвращается: всегда

Пример: {"encryption_context_equals": {"aws:lambda:_function_arn": "arn:aws:lambda:ap-southeast-2:123456789012:function:xyz"}}

creation_date

string

Дата создания гранта.

Возвращается: всегда

Пример: "2017-04-18T15:12:08+10:00"

grant_id

string

Уникальный идентификатор гранта.

Возвращается: всегда

Пример: "abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234abcd1234"

grantee_principal

string

Принципал, который получает разрешения гранта.

Возвращается: всегда

Пример: "arn:aws:sts::123456789012:assumed-role/lambda_xyz/xyz"

issuing_account

string

Учетная запись AWS, под которой был выдан грант.

Возвращается: всегда

Пример: "arn:aws:iam::123456789012:root"

key_id

string

ARN ключа, к которому применяется грант.

Возвращается: всегда

Пример: "arn:aws:kms:ap-southeast-2:123456789012:key/abcd1234-abcd-1234-5678-ef1234567890"

name

string

Дружественное имя, идентифицирующее грант.

Возвращается: всегда

Пример: "xyz"

operations

list / elements=string

Список операций, разрешенных грантом.

Возвращается: всегда

Пример: ["Decrypt", "GenerateDataKey"]

retiring_principal

string

Принципал, который может отозвать грант.

Возвращается: всегда

Пример: "arn:aws:sts::123456789012:assumed-role/lambda_xyz/xyz"

key_arn

string

ARN ключа.

Возвращается: всегда

Пример: "arn:aws:kms:ap-southeast-2:123456789012:key/abcd1234-abcd-1234-5678-ef1234567890"

key_id

string

ID ключа.

Возвращается: всегда

Пример: "abcd1234-abcd-1234-5678-ef1234567890"

key_manager

string

Менеджер ключа KMS.

Возвращается: всегда

Пример: "AWS"

key_policies

list / elements=dictionary

добавлено в community.aws 3.3.0

Список документов политик для ключа. Пусто, когда доступ запрещен, даже если политики есть.

Возвращается: всегда

Пример: {"Id": "auto-ebs-2", "Statement": [{"Action": ["kms:Encrypt", "kms:Decrypt", "kms:ReEncrypt*", "kms:GenerateDataKey*", "kms:CreateGrant", "kms:DescribeKey"], "Condition": {"StringEquals": {"kms:CallerAccount": "123456789012", "kms:ViaService": "ec2.ap-southeast-2.amazonaws.com"}}, "Effect": "Allow", "Principal": {"AWS": "*"}, "Resource": "*", "Sid": "Allow access through EBS for all principals in the account that are authorized to use EBS"}, {"Action": ["kms:Describe*", "kms:Get*", "kms:List*", "kms:RevokeGrant"], "Effect": "Allow", "Principal": {"AWS": "arn:aws:iam::123456789012:root"}, "Resource": "*", "Sid": "Allow direct access to key metadata to the account"}], "Version": "2012-10-17"}

key_spec

string

Указывает тип ключа KMS для создания.

Возвращается: всегда

Пример: "SYMMETRIC_DEFAULT"

key_state

string

Состояние ключа.

Будет одним из 'Creating', 'Enabled', 'Disabled', 'PendingDeletion', 'PendingImport', 'PendingReplicaDeletion', 'Unavailable', или 'Updating'.

Возвращается: всегда

Пример: "PendingDeletion"

key_usage

string

Криптографические операции, для которых можно использовать ключ.

Возвращается: всегда

Пример: "ENCRYPT_DECRYPT"

multi_region

boolean

Указывает, является ли ключ KMS многорегиональным (True) или региональным (False) ключом.

Возвращается: всегда

Пример: false

origin

string

Источник материала ключа. Когда это значение равно AWS_KMS, AWS KMS создал материал ключа. Когда это значение равно EXTERNAL, материал ключа был импортирован или CMK не имеет материала ключа.

Возвращается: всегда

Пример: "AWS_KMS"

tags

dictionary

Словарь тегов, примененных к ключу. Пусто, когда доступ запрещен, даже если теги есть.

Возвращается: всегда

Пример: {"Name": "myKey", "Purpose": "protecting_stuff"}