Spec-Zone.ru › Ansible

Модуль community.aws.secretsmanager_secret – Управление секретами, хранящимися в AWS Secrets Manager

Примечание

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

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

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

Для использования в книге задач укажите: community.aws.secretsmanager_secret.

Новая функция в community.aws 1.0.0

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

Обзор

  • Создание, обновление и удаление секретов, хранящихся в AWS Secrets Manager.
  • До версии 5.0.0 этот модуль назывался community.aws.aws_secret. Использование не изменилось.

Псевдонимы: aws_secret

Требования

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

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

Параметры

Параметр

Комментарии

access_key

aliases: aws_access_key_id, aws_access_key, ec2_access_key

string

Идентификатор ключа доступа 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 для согласованности с AWS botocore SDK.

Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной окружения EC2_ACCESS_KEY устарела и будет удалена в релизе после 2024-12-01.

aws_ca_bundle

path

Расположение пакета CA, используемого для проверки SSL-сертификатов.

Переменная окружения AWS_CA_BUNDLE также может использоваться.

aws_config

dictionary

Словарь для изменения конфигурации botocore.

Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

debug_botocore_endpoint_logs

boolean

Использовать botocore.endpoint регистратор для анализа уникальных (а не общих) "resource:action" вызовов API, сделанных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, сделанный во время playbook.

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

Варианты:

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

description

string

Указывает описание секрета, предоставленное пользователем.

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

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

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

Переменные окружения AWS_URL или EC2_URL также могут использоваться в порядке убывания приоритета.

Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменной окружения EC2_URL устарела и будет удалена в релизе после 2024-12-01.

json_secret

json

добавлено в community.aws 4.1.0

Указывает данные в формате JSON, которые вы хотите зашифровать и сохранить в новой версии секрета.

Взаимоисключающий с параметром secret.

kms_key_id

string

Указывает ARN или псевдоним основного ключа клиента AWS KMS (CMK), который будет использоваться для шифрования значений secret в версиях, хранящихся в этом секрете.

name

string / required

Удобное имя для создаваемого секрета.

overwrite

boolean

добавлено в community.aws 5.3.0

Перезаписывать ли существующий секрет с тем же именем.

Если установлено в True, существующий секрет с тем же name будет перезаписан.

Если установлено в False, секрет с заданным name будет создан только в том случае, если он не существует.

Варианты:

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

profile

aliases: aws_profile

string

Именованный профиль 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.

purge_tags

boolean

Если purge_tags=true и tags установлен, существующие теги будут очищены из ресурса, чтобы точно соответствовать тому, что определено параметром tags.

Если параметр tags не установлен, теги не будут изменены, даже если purge_tags=True.

Ключи тегов, начинающиеся с aws:, зарезервированы Amazon и не могут быть изменены. Таким образом, они будут игнорироваться для параметра purge_tags. См. документацию Amazon для получения дополнительной информации https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions.

Варианты:

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

recovery_window

integer

Используется только если состояние отсутствует.

Указывает количество дней, в течение которых Secrets Manager ожидает, прежде чем сможет удалить секрет.

Если установлено в 0, удаление принудительное без восстановления.

По умолчанию: 30

регион

псевдонимы: aws_region, ec2_region

строка

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

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

Также можно использовать переменные среды 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.

репликация

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

добавлен в community.aws 5.3.0

Указывает список регионов и kms_key_ids (необязательно) для репликации секрета.

kms_key_id

строка

Указывает ARN или псевдоним AWS KMS ключа шифрования в целевом регионе (если не указано, используется псевдоним /aws/secretsmanager).

регион

строка / обязательно

Регион для репликации секрета.

resource_policy

json

добавлен в community.aws 3.1.0

Указывает политику ресурса в формате JSON, которая должна быть прикреплена к секрету. Полезно для предоставления доступа к секретам из других учётных записей.

rotation_interval

целое число

Указывает количество дней между запланированными автоматическими вращениями секрета.

Значение по умолчанию: 30

rotation_lambda

строка

Указывает ARN функции Lambda, которая может вращать секрет.

секрет

строка

Указывает строковые или двоичные данные, которые нужно зашифровать и сохранить в новой версии секрета.

Взаимоисключительно с параметром json_secret.

Значение по умолчанию: ""

ключ_секрета

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

Параметры ключ_секрета и профиль взаимоисключающие.

Псевдоним aws_secret_access_key добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK.

Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_SECRET_KEY устарела и будет удалена в релизе после 2024-12-01.

тип_секрета

строка

Указывает тип данных, которые нужно зашифровать.

Варианты:

  • "binary"
  • "string" ← (по умолчанию)

токен_сессии

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

Параметры токен_сессии и профиль взаимоисключающие.

Псевдонимы aws_session_token и токен_сессии добавлены в релизе 3.2.0, а параметр был переименован из security_token в токен_сессии в релизе 6.0.0.

Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменных среды EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в релизе после 2024-12-01.

состояние

строка

Определяет, должен ли секрет существовать или нет.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

метки

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

словарь

Словарь, представляющий метки, которые нужно применить к ресурсу.

Если параметр метки не задан, метки не будут изменены.

validate_certs

булево

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

Устанавливать validate_certs=false категорически не рекомендуется; вместо этого можно установить aws_ca_bundle.

Варианты:

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

Примечания

Примечание

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

Примеры

- name: Add string to AWS Secrets Manager
  community.aws.secretsmanager_secret:
    name: 'test_secret_string'
    state: present
    secret_type: 'string'
    secret: "{{ super_secret_string }}"

- name: Add a secret with resource policy attached
  community.aws.secretsmanager_secret:
    name: 'test_secret_string'
    state: present
    secret_type: 'string'
    secret: "{{ super_secret_string }}"
    resource_policy: "{{ lookup('template', 'templates/resource_policy.json.j2', convert_data=False) | string }}"

- name: remove string from AWS Secrets Manager
  community.aws.secretsmanager_secret:
    name: 'test_secret_string'
    state: absent
    secret_type: 'string'
    secret: "{{ super_secret_string }}"

- name: Only create a new secret, but do not update if alredy exists by name
  community.aws.secretsmanager_secret:
    name: 'random_string'
    state: present
    secret_type: 'string'
    secret: "{{ lookup('community.general.random_string', length=16, special=false) }}"
    overwrite: false

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

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

Ключ

Описание

secret

сложный

Информация о секрете

Возвращается: всегда

arn

строка

ARN секрета.

Возвращается: всегда

Пример: "arn:aws:secretsmanager:eu-west-1:xxxxxxxxxx:secret:xxxxxxxxxxx"

описание

строка

Описание секрета.

Возвращается: при наличии описания секрета

Пример: "An example description"

дата_последнего_доступа

строка

Дата последнего доступа к секрету.

Возвращается: всегда

Пример: "2018-11-20T01:00:00+01:00"

дата_последнего_изменения

строка

Дата последнего изменения секрета.

Возвращается: всегда

Пример: "2018-11-20T12:16:38.433000+01:00"

имя

строка

Имя секрета.

Возвращается: всегда

Пример: "my_secret"

включена_ротация

логический

Статус ротации секрета.

Возвращается: всегда

Пример: false

метки

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

Список словарей, представляющих метки, связанные с секретом в стандартном формате boto3.

Возвращается: при наличии меток у секрета

ключ

строка

Имя или ключ метки.

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

Пример: "MyTag"

значение

строка

Значение метки.

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

Пример: "Some value."

словарь_меток

словарь

добавлен в community.aws 4.0.0

Словарь, представляющий метки, связанные с секретом.

Возвращается: при наличии меток у секрета

Пример: {"MyTagName": "Some Value"}

идентификаторы_версий_к_этапам

словарь

Предоставляет идентификаторы версий секрета и соответствующий этап секрета.

Возвращается: всегда

Пример: {"dc1ed59b-6d8e-4450-8b41-536dfe4600a9": ["AWSCURRENT"]}

Авторы

  • REY Remi (@rrey)

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

  • Трекер задач
  • Репозиторий (источники)
  • Связь

© 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/secretsmanager_secret_module.html

Spec-Zone.ru

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