Spec-Zone.ru › Ansible 2.9

aws_ssm_parameter_store – Управление парами ключ-значение в хранилище параметров aws

Новая версия 2.5.

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

Обзор

  • Управление парами ключ-значение в хранилище параметров aws.

Требования

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

  • boto
  • boto3
  • botocore
  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
aws_access_key
строка
Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.

Псевдонимы: ec2_access_key, access_key
aws_secret_key
строка
Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.

Псевдонимы: ec2_secret_key, secret_key
debug_botocore_endpoint_logs
логический тип
добавлен в 2.8
    Варианты:
  • нет ←
  • да
Использовать логирование botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», произведенных во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, выполненного во время выполнения playbook. Также может использоваться переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.
decryption
логический тип
    Варианты:
  • нет
  • да ←
Работа с типом SecureString для получения секретов в открытом тексте
description
-
Описание ключа параметра.
ec2_url
строка
URL для подключения к облаку EC2 или Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где регион является обязательным. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL (при наличии).
key_id
-
По умолчанию:
"aws/ssm (этот ключ автоматически генерируется при создании первого параметра)."
Ключ AWS KMS для расшифровки секретов.
name
- / обязательно
Имя ключа параметра.
overwrite_value
-
добавлен в 2.6
    Варианты:
  • никогда
  • изменено ←
  • всегда
Вариант перезаписи существующего значения, если оно уже существует.
Строка
profile
строка
Использует профиль boto. Работает только с boto >= 2.24.0.
region
-
Регион.
security_token
строка
Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.

Псевдонимы: access_token
state
-
    Варианты:
  • настоящий ←
  • отсутствует
Создает или изменяет существующий параметр
Удаляет параметр
string_type
-
    Варианты:
  • Строка ←
  • Список строк
  • SecureString
Тип параметра String
validate_certs
логический тип
    Варианты:
  • нет
  • да ←
При значении «нет» сертификаты SSL для версий boto >= 2.6.0 не будут проверяться.
value
-
Значение параметра.

Примечания

Примечание

  • Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета AWS_URL или EC2_URL, AWS_ACCESS_KEY_ID или AWS_ACCESS_KEY или EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY или AWS_SECRET_KEY или EC2_SECRET_KEY, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN, AWS_REGION или EC2_REGION
  • Ansible использует файл конфигурации boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
  • AWS_REGION или EC2_REGION обычно используются для указания региона AWS, если он требуется, но это также можно настроить в файле конфигурации boto

Примеры

- name: Create or update key/value pair in aws parameter store
  aws_ssm_parameter_store:
    name: "Hello"
    description: "This is your first key"
    value: "World"

- name: Delete the key
  aws_ssm_parameter_store:
    name: "Hello"
    state: absent

- name: Create or update secure key/value pair with default kms key (aws/ssm)
  aws_ssm_parameter_store:
    name: "Hello"
    description: "This is your first key"
    string_type: "SecureString"
    value: "World"

- name: Create or update secure key/value pair with nominated kms key
  aws_ssm_parameter_store:
    name: "Hello"
    description: "This is your first key"
    string_type: "SecureString"
    key_id: "alias/demo"
    value: "World"

- name: Always update a parameter store value and create a new version
  aws_ssm_parameter_store:
    name: "overwrite_example"
    description: "This example will always overwrite the value"
    string_type: "String"
    value: "Test1234"
    overwrite_value: "always"

- name: recommend to use with aws_ssm lookup plugin
  debug: msg="{{ lookup('aws_ssm', 'hello') }}"

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

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

Ключ Возвращено Описание
delete_parameter
словарь
успех
Удаление параметра из системы.

put_parameter
словарь
успех
Добавление одного или нескольких параметров в систему.



Статус

  • Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • Nathan Webster (@nathanwebsterdotme)
  • Bill Wang (@ozbillwang) <ozbillwang@gmail.com>
  • Michael De La Rue (@mikedlr)

Подсказка

Если вы обнаружите проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/aws_ssm_parameter_store_module.html

Spec-Zone.ru

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