amazon.aws.aws_secret – Поиск секретов, хранящихся в AWS Secrets Manager.

Примечание

Этот плагин является частью коллекции amazon.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install amazon.aws.

Для использования в плейбуке укажите: amazon.aws.aws_secret.

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

Обзор

Поиск секретов, хранящихся в AWS Secrets Manager, при условии, что у вызывающего есть соответствующие разрешения на чтение секрета.
Поиск выполняется на основе значения Name секрета.
В этот поиск можно передать дополнительные параметры; version_id и version_stage

Требования

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

boto3
botocore>=1.10.0

Параметры

Параметр	Варианты/Значения по умолчанию	Конфигурация	Комментарии
_terms строка / обязательно			Имя секрета для поиска в AWS Secrets Manager.
aws_access_key строка		env:EC2_ACCESS_KEY env:AWS_ACCESS_KEY env:AWS_ACCESS_KEY_ID	AWS ключ доступа для использования. Псевдонимы: aws_access_key_id
aws_profile строка		env:AWS_DEFAULT_PROFILE env:AWS_PROFILE	AWS профиль Псевдонимы: boto_profile
aws_secret_key строка		env:EC2_SECRET_KEY env:AWS_SECRET_KEY env:AWS_SECRET_ACCESS_KEY	AWS секретный ключ, соответствующий ключу доступа. Псевдонимы: aws_secret_access_key
aws_security_token строка		env:EC2_SECURITY_TOKEN env:AWS_SESSION_TOKEN env:AWS_SECURITY_TOKEN	AWS токен безопасности, если используются временные ключи доступа и секретные ключи.
join булево	Варианты: нет ← да		Объединить два или более записей для создания расширенного секрета. Это полезно для преодоления ограничения AWS в 4096 символов.
on_denied строка	Варианты: ошибка ← пропустить предупреждение		Действие, которое нужно выполнить, если доступ к секрету запрещен. `error` вызовет ошибку при отказе в доступе к секрету. `skip` проигнорирует запрещенный секрет. `warn` пропустит запрещенный секрет, но выведет предупреждение.
on_missing строка	Варианты: ошибка ← пропустить предупреждение		Действие, которое нужно выполнить, если секрет отсутствует. `error` вызовет ошибку, если секрет отсутствует. `skip` проигнорирует отсутствующий секрет. `warn` пропустит отсутствующий секрет, но выведет предупреждение.
region строка		env:EC2_REGION env:AWS_REGION	Регион для создания соединения.
version_id строка			Версия секрета(ов).
version_stage строка			Этап версии секрета.

Примеры

- name: Create RDS instance with aws_secret lookup for password param
  rds:
    command: create
    instance_name: app-db
    db_engine: MySQL
    size: 10
    instance_type: db.m1.small
    username: dbadmin
    password: "{{ lookup('aws_secret', 'DbSecret') }}"
    tags:
      Environment: staging

- name: skip if secret does not exist
  debug: msg="{{ lookup('aws_secret', 'secret-not-exist', on_missing='skip')}}"

- name: warn if access to the secret is denied
  debug: msg="{{ lookup('aws_secret', 'secret-denied', on_denied='warn')}}"

Возвращаемые значения

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

Ключ	Возвращаемое значение	Описание
_raw строка	успех	Возвращает значение секрета, хранящегося в AWS Secrets Manager.

Авторы

Aaron Smith <ajsmith10381@gmail.com>

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/amazon/aws/aws_secret_lookup.html