Spec-Zone.ru › Ansible

Модуль community.aws.accessanalyzer_validate_policy_info – выполняет проверку политик IAM

Примечание

Этот модуль входит в коллекцию community.aws (версия 10.1.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.34.0
  • botocore >= 1.34.0

Параметры

Параметр

Комментарии

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 SDK botocore.

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 результатов задачи. Используйте callback aws_resource_action, чтобы вывести полный список вызовов, выполненных во время плейбука.

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

Варианты:

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

endpoint_url

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

строка

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

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

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

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

строка

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

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 ← (по умолчанию)

Примечания

Примечание

  • Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста «узла» Ansible, а не из контекста «контроллера». Поэтому файлы может потребоваться явно скопировать на «узел». Для подключаемых модулей поиска и подключения переменные среды и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «узла».
  • Используемый Ansible пакет AWS SDK (boto3) также может считывать значения учетных данных и других параметров по умолчанию, например региона, из файлов конфигурации в контексте «узла» 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/aws/accessanalyzer_validate_policy_info_module.html

Spec-Zone.ru

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