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

Примечание

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

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

Для использования в playbook, укажите: 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 логический тип	Варианты: нет ← да		Объединить две или более записей в расширенный секрет. Это полезно для преодоления ограничения в 4096 символов, накладываемого AWS.
on_denied строка	Варианты: ошибка ← пропустить предупреждение		Действие, которое необходимо выполнить, если доступ к секрету запрещен. `error` приведет к ошибке fatal при отказе в доступе к секрету. `skip` будет молча игнорировать запрещенный секрет. `warn` пропустит запрещенный секрет, но выведет предупреждение.
on_missing строка	Варианты: ошибка ← пропустить предупреждение		Действие, которое необходимо выполнить, если секрет отсутствует. `error` приведет к ошибке fatal при отсутствии секрета. `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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/amazon/aws/aws_secret_lookup.html