Spec-Zone.ru › Ansible

community.aws.accessanalyzer_validate_policy_info модуль — Выполняет валидацию политик IAM

Примечание

Этот модуль является частью коллекции community.aws (версия 8.0.0).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.aws. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Чтобы использовать его в книге задач, укажите: community.aws.accessanalyzer_validate_policy_info.

Новое в community.aws 5.0.0

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Описание

  • Запрашивает валидацию политики и возвращает список результатов.

Требования

Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.

  • python >= 3.6
  • boto3 >= 1.26.0
  • botocore >= 1.29.0

Параметры

Параметр

Комментарии

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.

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.

locale

строка

Язык для локализации результатов.

Поддерживаемые языки включают DE, EN, ES, FR, IT, JA, KO, PT_BR, ZH_CN и ZH_TW.

Дополнительную информацию о поддерживаемых языках см. в документации AWS https://docs.aws.amazon.com/access-analyzer/latest/APIReference/API_ValidatePolicy.html

По умолчанию: "EN"

policy

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

json / обязательный

Политика в формате JSON.

policy_type

строка

Тип проверяемой политики.

identity политики предоставляют разрешения принципалам IAM, включая управляемые и встроенные политики для ролей IAM, пользователей и групп.

resource политики предоставляют разрешения на ресурсы AWS, включая политики доверия для ролей IAM и политики ведер для ведер S3.

Варианты:

  • "identity" ← (по умолчанию)
  • "resource"
  • "service_control"

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.

resource_type

строка

Тип ресурса, который нужно прикрепить к политике ресурса.

Игнорируется, если policy_type=resource.

Поддерживаемые типы ресурсов включают AWS::S3::Bucket, AWS::S3::AccessPoint, AWS::S3::MultiRegionAccessPoint и AWS::S3ObjectLambda::AccessPoint

Для типов ресурсов, не поддерживаемых как допустимые значения, IAM Access Analyzer выполняет проверки политики, которые применяются ко всем политикам ресурсов.

Дополнительную информацию о поддерживаемых языках см. в документации AWS https://docs.aws.amazon.com/access-analyzer/latest/APIReference/API_ValidatePolicy.html

results_filter

список / элементы=строка

Отфильтровать результаты и ограничить их определенными типами находок.

Варианты:

  • "error"
  • "security"
  • "suggestion"
  • "warning"

secret_key

псевдонимы: aws_secret_access_key, aws_secret_key, ec2_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, или 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

псевдонимы: aws_session_token, security_token, aws_security_token, access_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, 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

логическое

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

Установка validate_certs=false категорически не рекомендуется, вместо этого рассмотрите настройку aws_ca_bundle.

Варианты:

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

Примечания

Примечание

  • Внимание: Для модулей переменные среды и конфигурационные файлы читаются из контекста Ansible «хост», а не «контроллер». Поэтому файлы может потребоваться явно скопировать на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы читаются из контекста Ansible «контроллер», а не «хост».
  • AWS SDK (boto3), который использует Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте Ansible «хост» (обычно ~/.aws/credentials). Дополнительную информацию см. в https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

# Validate a policy
- name: Validate a simple IAM policy
  community.aws.accessanalyzer_validate_policy_info:
    policy: "{{ lookup('template', 'managed_policy.json.j2') }}"

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:

Ключ

Описание

findings

список / элементы=словарь

Список результатов анализа политики, возвращённый IAM Access Analyzer на основе набора проверок политик.

Возвращается при: успехе

finding_details

строка

Локализованное сообщение, описывающее результат.

Возвращается при: успехе

Пример: "Resource ARN does not match the expected ARN format. Update the resource portion of the ARN."

finding_type

строка

Степень важности результата.

Возвращается при: успехе

Пример: "ERROR"

issue_code

строка

Идентификатор типа обнаруженной проблемы.

Возвращается при: успехе

Пример: "INVALID_ARN_RESOURCE"

learn_more_link

строка

Ссылка на дополнительную информацию о типе результата.

Возвращается при: успехе

Пример: "https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-policy-checks.html"

locations

список / элементы=словарь

Расположение элемента, приведшего к рекомендациям.

Возвращается при: успехе

path

список / элементы=словарь

Путь в политике, представленный как последовательность элементов пути.

Возвращается при: успехе

Пример: [{"value": "Statement"}, {"index": 0}, {"value": "Resource"}, {"index": 0}]

span

словарь

Место в политике, на которое ссылается результат.

Примечание - при использовании поисковых запросов или передаче словарей в policy строка политики может быть преобразована в одну строку JSON, изменяя значения столбца, строки и смещения.

Возвращается при: успехе

end

словарь

Конечная позиция раздела.

Возвращается при: успехе

column

целое число

Столбец позиции, начиная с 0.

Возвращается при: успехе

line

целое число

Строка позиции, начиная с 1.

Возвращается при: успехе

offset

целое число

Смещение в политике, соответствующее позиции, начиная с 0.

Возвращается при: успехе

start

словарь

Начальная позиция раздела.

Возвращается при: успехе

column

целое число

Столбец позиции, начиная с 0.

Возвращается при: успехе

line

целое число

Строка позиции, начиная с 1.

Возвращается при: успехе

offset

целое число

Смещение в политике, соответствующее позиции, начиная с 0.

Возвращается при: успехе

Авторы

  • Mark Chappell (@tremble)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходные коды)
  • Общение

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/accessanalyzer_validate_policy_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API