Модуль community.aws.ssm_parameter — управление парами ключ-значение в хранилище параметров AWS Systems Manager

Примечание

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

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

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

Чтобы использовать модуль в сценарии, укажите: community.aws.ssm_parameter.

Добавлено в community.aws 1.0.0

Краткое описание
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Краткое описание

Управление парами ключ-значение в хранилище параметров AWS Systems Manager (SSM).
До выпуска версии 5.0.0 этот модуль назывался community.aws.aws_ssm_parameter_store. Способ его использования не изменился.

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

Требования

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

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 путь	Путь к пакету сертификатов центра сертификации, используемому для проверки 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 результатов задачи. Используйте обработчик `aws_resource_action`, чтобы вывести общий список вызовов, выполненных во время сценария. Также можно использовать переменную окружения `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
decryption логическое значение	Работа со значениями типа SecureString для получения секретов в открытом виде Варианты: `false` `true` ← (по умолчанию)
description строка	Описание ключа параметра.
endpoint_url псевдонимы: aws_endpoint_url строка	URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную окружения `AWS_URL`.
key_id строка	Ключ AWS KMS для расшифровки секретов. Ключ по умолчанию (`alias/aws/ssm`) автоматически создается при первом запросе. По умолчанию: `"alias/aws/ssm"`
name строка / обязательный	Имя ключа параметра.
overwrite_value строка	Параметр, определяющий, следует ли перезаписать существующее значение. Варианты: `"never"` `"changed"` ← (по умолчанию) `"always"`
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.
purge_tags логическое значение	Если задано `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` ← (по умолчанию)
region псевдонимы: aws_region строка	Регион AWS для использования. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную окружения `AWS_REGION`. Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
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 являются взаимоисключающими.
state строка	Создает параметр или изменяет существующий. Удаляет параметр. Варианты: `"present"` ← (по умолчанию) `"absent"`
string_type псевдонимы: type строка	Тип строки параметра. Варианты: `"String"` ← (по умолчанию) `"StringList"` `"SecureString"`
tags псевдонимы: resource_tags словарь	Словарь тегов, применяемых к ресурсу. Если параметр `tags` не задан, теги не будут изменены.
tier строка добавлено в community.aws 1.5.0	Уровень хранилища параметров. Варианты: `"Standard"` ← (по умолчанию) `"Advanced"` `"Intelligent-Tiering"`
validate_certs логическое значение	Если задано `false`, SSL-сертификаты для связи с API AWS проверяться не будут. Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)
value строка	Значение параметра.

Примечания

Примечание

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

См. также

Поисковый плагин amazon.aws.aws_ssm: Документация по поисковому плагину amazon.aws.aws_ssm.

Примеры

- name: Create or update key/value pair in AWS SSM parameter store
  community.aws.ssm_parameter:
    name: "Hello"
    description: "This is your first key"
    value: "World"

- name: Delete the key
  community.aws.ssm_parameter:
    name: "Hello"
    state: absent

- name: Create or update secure key/value pair with default KMS key (aws/ssm)
  community.aws.ssm_parameter:
    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
  community.aws.ssm_parameter:
    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
  community.aws.ssm_parameter:
    name: "overwrite_example"
    description: "This example will always overwrite the value"
    string_type: "String"
    value: "Test1234"
    overwrite_value: "always"

- name: Create or update key/value pair in AWS SSM parameter store with tier
  community.aws.ssm_parameter:
    name: "Hello"
    description: "This is your first key"
    value: "World"
    tier: "Advanced"

- name: recommend to use with aws_ssm lookup plugin
  ansible.builtin.debug:
    msg: "{{ lookup('amazon.aws.aws_ssm', 'Hello') }}"

- name: Create or update key/value pair in AWS SSM parameter store w/ tags
  community.aws.ssm_parameter:
    name: "Hello"
    description: "This is your first key"
    value: "World"
    tags:
      Environment: "dev"
      Version: "1.0"
      Confidentiality: "low"
      Tag With Space: "foo bar"

- name: Add or update a tag on an existing parameter w/o removing existing tags
  community.aws.ssm_parameter:
    name: "Hello"
    purge_tags: false
    tags:
      Contact: "person1"

- name: Delete all tags on an existing parameter
  community.aws.ssm_parameter:
    name: "Hello"
    tags: {}

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

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

Ключ	Описание
parameter_metadata словарь	Сведения о параметре. Не включает значение параметра, так как оно может содержать конфиденциальную информацию. Возвращается: при успешном выполнении
data_type строка	Тип данных параметра. Возвращается: при успешном выполнении Пример: `"text"`
description строка	Описание ключа параметра. Возвращается: при успешном выполнении Пример: `"This is your first key"`
last_modified_date строка	Дата и время последнего изменения параметра. Возвращается: при успешном выполнении Пример: `"2022-06-20T09:56:58.573000+00:00"`
last_modified_user строка	ARN последнего пользователя, изменившего параметр. Возвращается: при успешном выполнении Пример: `"arn:aws:sts::123456789012:assumed-role/example-role/session=example"`
name строка	Имя ключа параметра. Возвращается: при успешном выполнении Пример: `"Hello"`
policies список / элементы=словарь	Список политик, связанных с параметром. Возвращается: при успешном выполнении
policy_status строка	Статус политики. Возвращается: при успешном выполнении Пример: `"Pending"`
policy_text строка	Текст политики в формате JSON. Возвращается: при успешном выполнении
policy_type строка	Тип политики. Возвращается: при успешном выполнении Пример: `"Expiration"`
tags словарь добавлено в community.aws 5.3.0	Словарь тегов, связанных с параметром. Возвращается: если у параметра есть теги Пример: `{"MyTagName": "Some Value"}`
tier строка	Уровень параметра. Возвращается: при успешном выполнении Пример: `"Standard"`
type строка	Тип параметра Возвращается: при успешном выполнении Пример: `"String"`
version целое число	Номер версии параметра Возвращается: при успешном выполнении Пример: `3`

Авторы

Davinder Pal (@116davinder)
Nathan Webster (@nathanwebsterdotme)
Bill Wang (@ozbillwang)
Michael De La Rue (@mikedlr)

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

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