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

access_key

псевдонимы: aws_access_key_id, aws_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 в порядке убывания приоритета.

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

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

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 для разбора уникальных (а не общих) вызовов API "resource:action", выполненных в ходе задачи, и записывать их набор в ключ resource_actions результатов задачи. Используйте обработчик aws_resource_action, чтобы вывести полный список вызовов, выполненных в плейбуке.

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

Варианты:

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

endpoint_url

псевдоним: aws_endpoint_url

строка

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

Также можно использовать переменную окружения AWS_URL.

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 и session_token.

region

псевдоним: aws_region

строка

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

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

Также можно использовать переменную окружения AWS_REGION.

Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

secret_key

псевдонимы: aws_secret_access_key, aws_secret_key

строка

Секретный ключ доступа 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 в порядке убывания приоритета.

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

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

session_token

псевдоним: aws_session_token

строка

Токен сеанса 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.

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

validate_certs

логический

Если задано значение 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

ID учетной записи 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 имеет значение 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 имеет значение 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"}