Поиск amazon.aws.ssm_parameter — получает значение параметра SSM или всех параметров по указанному пути

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

• Получает значение параметра Amazon Simple Systems Manager или иерархии параметров. Первым аргументом поиска можно передать имя параметра или иерархию параметров. Иерархия начинается с косой черты и заканчивается именем параметра. Можно указать до 5 уровней.
• Если выполняется поиск явно указанного по имени параметра, который не существует, поиск завершится ошибкой. В этом случае для задания значения по умолчанию можно использовать фильтр default, но необходимо установить параметр on_missing в значение skip или warn. Также необходимо установить второй параметр фильтра default в значение true (см. примеры ниже).
• При поиске параметров по пути для каждого пути будет возвращён словарь. Если по этому пути нет параметров, поиск завершится ошибкой.
• Если поиск завершается неудачей из-за недостатка разрешений или ошибки клиента AWS, aws_ssm выдаст ошибку. Чтобы продолжить работу в этом случае, необходимо настроить две задачи Ansible: одна задаёт переменную и игнорирует сбои, а другая использует значение этой переменной со значением по умолчанию. См. примеры ниже.
• До выпуска 6.0.0 этот модуль назывался aws_ssm, его использование осталось прежним.

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

Требования

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

• python >= 3.6
• boto3 >= 1.35.0
• botocore >= 1.35.0

Параметры-ключевые слова

Здесь описаны параметры-ключевые слова поиска. В приведённых ниже примерах это значения key1=value1, key2=value2 и так далее: lookup('amazon.aws.ssm_parameter', key1=value1, key2=value2, ...) и query('amazon.aws.ssm_parameter', key1=value1, key2=value2, ...)

Примечания

Примеры

# lookup sample:
- name: Lookup ssm parameter store in the current region
  ansible.builtin.debug: msg="{{ lookup('amazon.aws.aws_ssm', 'Hello' ) }}"

- name: Lookup ssm parameter store in specified region
  ansible.builtin.debug: msg="{{ lookup('amazon.aws.aws_ssm', 'Hello', region='us-east-2' ) }}"

- name: Lookup ssm parameter store without decryption
  ansible.builtin.debug: msg="{{ lookup('amazon.aws.aws_ssm', 'Hello', decrypt=False ) }}"

- name: Lookup ssm parameter store using a specified aws profile
  ansible.builtin.debug: msg="{{ lookup('amazon.aws.aws_ssm', 'Hello', profile='myprofile' ) }}"

- name: Lookup ssm parameter store using explicit aws credentials
  ansible.builtin.debug:
    msg: >-
      {{ lookup('amazon.aws.aws_ssm', 'Hello', access_key=my_aws_access_key, secret_key=my_aws_secret_key, session_token=my_session_token ) }}"

- name: Lookup ssm parameter store with all options
  ansible.builtin.debug: msg="{{ lookup('amazon.aws.aws_ssm', 'Hello', decrypt=false, region='us-east-2', profile='myprofile') }}"

- name: Lookup ssm parameter and fail if missing
  ansible.builtin.debug: msg="{{ lookup('amazon.aws.aws_ssm', 'missing-parameter') }}"

- name: Lookup a key which doesn't exist, returning a default ('root')
  ansible.builtin.debug: msg="{{ lookup('amazon.aws.aws_ssm', 'AdminID', on_missing="skip") | default('root', true) }}"

- name: Lookup a key which doesn't exist failing to store it in a fact
  ansible.builtin.set_fact:
    temp_secret: "{{ lookup('amazon.aws.aws_ssm', '/NoAccess/hiddensecret') }}"
  ignore_errors: true

- name: Show fact default to "access failed" if we don't have access
  ansible.builtin.debug: msg="{{ 'the secret was:' ~ temp_secret | default('could not access secret') }}"

- name: Return a dictionary of ssm parameters from a hierarchy path
  ansible.builtin.debug: msg="{{ lookup('amazon.aws.aws_ssm', '/PATH/to/params', region='ap-southeast-2', bypath=true, recursive=true ) }}"

- name: Return a dictionary of ssm parameters from a hierarchy path with shortened names (param instead of /PATH/to/params/foo/bar/param)
  ansible.builtin.debug: msg="{{ lookup('amazon.aws.aws_ssm', '/PATH/to/params', region='ap-southeast-2', shortnames=true, bypath=true, recursive=true ) }}"

- name: Return a dictionary of ssm parameters from a hierarchy path with the heirarchy path dropped (foo/bar/param instead of /PATH/to/params/foo/bar/param)
  ansible.builtin.debug: msg="{{ lookup('amazon.aws.aws_ssm', '/PATH/to/params', region='ap-southeast-2', droppath=true, bypath=true, recursive=true ) }}"

- name: Iterate over a parameter hierarchy (one iteration per parameter)
  ansible.builtin.debug: msg='Key contains {{ item.key }} , with value {{ item.value }}'
  loop: "{{ lookup('amazon.aws.aws_ssm', '/demo/', region='ap-southeast-2', bypath=True) | dict2items }}"

- name: Iterate over multiple paths as dictionaries (one iteration per path)
  ansible.builtin.debug: msg='Path contains {{ item }}'
  loop: "{{ lookup('amazon.aws.aws_ssm', '/demo/', '/demo1/', bypath=True)}}"

- name: Lookup ssm parameter warn if access is denied
  ansible.builtin.debug: msg="{{ lookup('amazon.aws.aws_ssm', 'missing-parameter', on_denied="warn" ) }}"