Spec-Zone.ru › Ansible

amazon.aws.lambda_info модуль – Сбор данных о функциях AWS Lambda

Примечание

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

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

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

Для использования в плейбуке укажите: amazon.aws.lambda_info.

Добавлен в amazon.aws 5.0.0

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

Обзор

  • Сбор различных данных о функциях Lambda, включая псевдонимы, версии и соответствия источников событий.
  • Используйте модуль amazon.aws.lambda для управления самой функцией Lambda, amazon.aws.lambda_alias для управления псевдонимами функций, amazon.aws.lambda_event для управления соответствиями источников событий, и amazon.aws.lambda_policy для управления политиками.
  • Этот модуль был первоначально добавлен в community.aws в релизе 1.0.0.

Требования

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

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

Параметры

Параметр

Комментарии

access_key

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

Параметры aws_access_key и profile взаимоисключающие.

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

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

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

aws_ca_bundle

путь

Расположение файла 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 логгер для анализа уникальных (а не общих) "resource:action" API-вызовов, сделанных во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте aws_resource_action обратный вызов для вывода общего списка, сделанного во время выполнения playbook.

Также может быть использована переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

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

endpoint_url

псевдонимы: ec2_url, aws_endpoint_url, s3_url

строка

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

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

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

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

event_source_arn

строка

Если query=mappings, это Amazon Resource Name (ARN) потока Amazon Kinesis или DynamoDB.

function_name

псевдонимы: function, name

строка

Имя lambda-функции, для которой запрашивается информация.

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 и security_token.

query

строка

Указывает тип ресурса, для которого требуется собрать информацию.

По умолчанию all при указании function_name.

По умолчанию config при отсутствии указания function_name.

Варианты:

  • "aliases"
  • "all"
  • "config"
  • "mappings"
  • "policy"
  • "versions"
  • "tags"

region

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

строка

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

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

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

secret_key

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

Параметры secret_key и profile взаимоисключающие.

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

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

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

END_OF_DOCUMENT_MARKER

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

Токен сессии AWS STS для использования с временными учетными данными.

См. документацию AWS для получения дополнительной информации об access token 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 в порядке убывания приоритета.

Параметры security_token и profile взаимоисключающие.

Алиасы aws_session_token и session_token были добавлены в релизе 3.2.0, при этом параметр был переименован из security_token в session_token в релизе 6.0.0.

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

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

validate_certs

boolean

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

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

Варианты:

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

Примечания

Примечание

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

Примеры

---
# Simple example of listing all info for a function
- name: List all for a specific function
  amazon.aws.lambda_info:
    query: all
    function_name: myFunction
  register: my_function_details

# List all versions of a function
- name: List function versions
  amazon.aws.lambda_info:
    query: versions
    function_name: myFunction
  register: my_function_versions

# List all info for all functions
- name: List all functions
  amazon.aws.lambda_info:
    query: all
  register: output

- name: show Lambda information
  ansible.builtin.debug:
    msg: "{{ output['function'] }}"

Значения возврата

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

Ключ

Описание

function

словарь

Список функций Lambda.

function устарел и будет удален в следующей основной версии после 2025-01-01.

Возвращаемое значение: успех

function.TheName

словарь

Информация о функции Lambda, включая информацию о событиях, отображениях и версиях.

function устарел и будет удален в следующей основной версии после 2025-01-01.

Возвращаемое значение: успех

functions

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

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

Список информации для каждой функции lambda, соответствующей запросу.

Возвращаемое значение: всегда

aliases

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

Псевдонимы, связанные с функцией.

Возвращаемое значение: когда query=aliases или query=all

architectures

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

Архитектуры, поддерживаемые функцией.

Возвращаемое значение: успех

Пример: ["arm64"]

code_sha256

строка

Хеш SHA256 пакета развертывания функции.

Возвращаемое значение: успех

Пример: "zOAGfF5JLFuzZoSNirUtOrQp+S341IOA3BcoXXoaIaU="

code_size

целое число

Размер пакета развертывания функции в байтах.

Возвращаемое значение: успех

Пример: 123

dead_letter_config

словарь

Очередь «мертвых писем» функции.

Возвращаемое значение: когда для функции настроена очередь «мертвых писем»

Пример: {"target_arn": "arn:aws:lambda:us-east-1:123456789012:function:myFunction:1"}

target_arn

строка

ARN очереди SQS или темы SNS.

Возвращаемое значение: когда для функции настроена очередь «мертвых писем»

Пример: "arn:aws:lambda:us-east-1:123456789012:function:myFunction:1"

description

строка

Описание функции.

Возвращаемое значение: успех

Пример: "My function"

environment

словарь

Переменные среды функции.

Возвращаемое значение: когда переменные среды существуют

error

словарь

Сообщение об ошибке для переменных среды, которые не могли быть применены.

Возвращаемое значение: когда возникает ошибка при применении переменных среды

error_code

строка

Код ошибки.

Возвращаемое значение: когда возникает ошибка при применении переменных среды

message

строка

Сообщение об ошибке.

Возвращаемое значение: когда возникает ошибка при применении переменных среды

variables

словарь

Значения переменных среды в формате ключ-значение.

Возвращаемое значение: когда переменные среды существуют

Пример: {"key": "value"}

ephermal_storage

словарь

Размер каталога /tmp функции в МБ.

Возвращаемое значение: успех

size

целое число

Размер каталога /tmp функции.

Возвращаемое значение: всегда

Пример: 512

function_arn

строка

Amazon Resource Name (ARN) функции.

Возвращаемое значение: при успешном выполнении

Пример: "arn:aws:lambda:us-east-1:123456789012:function:myFunction:1"

function_name

string

Имя функции.

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

Пример: "myFunction"

handler

string

Функция, вызываемая Lambda для начала выполнения вашей функции.

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

Пример: "index.handler"

last_modified

string

Дата и время последнего обновления функции в формате ISO-8601 (YYYY-MM-DDThh:mm:ssTZD).

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

Пример: "2017-08-01T00:00:00.000+0000"

mappings

list / elements=dictionary

Список сведений о конфигурации для каждого сопоставления источника событий.

Возвращается: когда query=all или query=mappings

batch_size

integer

Максимальное количество записей, которые AWS Lambda будет получать из источника событий во время вызова функции.

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

event_source_arn

string

ARN потока Amazon Kinesis или DynamoDB, являющегося источником событий.

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

function_arn

string

Функция Lambda, вызываемая, когда AWS Lambda обнаруживает событие в источнике на основе опроса.

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

last_modified

string

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

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

last_processing_result

string

Результат последнего вызова AWS Lambda вашей функции Lambda.

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

state

string

Состояние сопоставления источника событий.

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

state_transition_reason

string

Причина, по которой сопоставление источника событий находится в текущем состоянии.

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

uuid

string

Непрозрачный идентификатор, назначенный AWS Lambda для сопоставления.

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

memory_size

integer

Память, выделенная для функции.

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

Пример: 128

package_type

string

Тип пакета развертывания.

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

Пример: "Zip"

policy

dictionary

Политика, связанная с функцией.

Возвращается: когда query=all или query=policy

revision_id

string

Последняя обновленная версия функции или псевдонима.

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

Пример: "a2x9886d-d48a-4a0c-ab64-82abc005x80c"

role

string

Роль выполнения функции.

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

Пример: "arn:aws:iam::123456789012:role/lambda_basic_execution"

runtime

string

Среда выполнения для функции Lambda.

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

Пример: "nodejs6.10"

runtime_version_config

dictionary

ARN среды выполнения и любые возникшие ошибки.

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

runtime_version_arn

string

ARN исполняемой версии, которую вы хотите использовать для функции.

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

Пример: "arn:aws:lambda:us-west-2::runtime:123456789012"

snap_start

dictionary

Снимок начатой среды выполнения при публикации версии функции.

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

apply_on

string

При установке в значение PublishedVersions, Lambda создаёт снимок среды выполнения при публикации версии функции.

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

Пример: "None"

optimization_status

string

Этот элемент указывает, активирован ли SnapStart для указанной версии функции.

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

Пример: "Off"

timeout

integer

Время, которое Lambda позволяет функции работать перед её завершением.

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

Пример: 3

tracing_config

dictionary

Настройка отслеживания AWS X-Ray для функции.

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

Пример: {"mode": "Active"}

mode

string

Режим отслеживания.

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

Пример: "Active"

version

string

Версия функции Lambda.

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

Пример: "1"

versions

list / elements=dictionary

Список версий функции Lambda.

Возвращается: при query=all или query=versions

vpc_config

dictionary

Конфигурация сети функции.

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

Пример: {"security_group_ids": [], "subnet_ids": [], "vpc_id": "123"}

Авторы

  • Pierre Jodouin (@pjodouin)

Ссылки на сборку

  • Отслеживание проблем
  • Репозиторий (источники)
  • Общение

© 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/amazon/aws/lambda_info_module.html

Spec-Zone.ru

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