community.aws.s3_metrics_configuration – Управление конфигурацией метрик ведра s3 в AWS
Примечание
Этот плагин входит в коллекцию community.aws (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.aws.
Для использования в книге задач укажите: community.aws.s3_metrics_configuration.
Новое в версии 1.3.0: коллекции community.aws
Описание
- Управление конфигурацией метрик ведра s3 в AWS, позволяющее получить метрики запросов CloudWatch для объектов в ведре
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- boto
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aws_access_key строка | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Если задан параметр profile, этот параметр игнорируется. Передача параметров aws_access_key и profile одновременно устарела и параметры станут взаимоисключающими после 2022-06-01. Псевдонимы: ec2_access_key, access_key | |
| aws_ca_bundle путь | Расположение файла CA сертификатов для проверки SSL сертификатов. Используется только для модулей на основе boto3. Примечание: Файл CA Bundle считывается на стороне модуля и может потребоваться явно скопировать его с контроллера, если он не запускается локально. | |
| aws_config словарь | Словарь для модификации конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. Более подробную информацию о конфигурации boto см. по адресу http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto. | |
| aws_secret_key строка | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если задан параметр profile, этот параметр игнорируется. Передача параметров aws_secret_key и profile одновременно устарела и параметры станут взаимоисключающими после 2022-06-01. Псевдонимы: ec2_secret_key, secret_key | |
| bucket_name строка / обязательно | Имя ведра s3 | |
| debug_botocore_endpoint_logs логический тип |
| Используйте регистрирующий логгер botocore.endpoint для анализа уникальных (а не общих) API-вызовов "ресурс:действие", выполняемых во время задачи, выведя множество в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в список общих вызовов, сделанных во время книги задач. Переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS также может использоваться. |
| ec2_url строка | URL для подключения к EC2 или вашей облачной платформе Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где регион обязателен. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть. Псевдонимы: aws_endpoint_url, endpoint_url | |
| filter_prefix строка | Префикс, используемый при оценке фильтра метрик. | |
| filter_tags словарь | Словарь одного или нескольких тегов, используемых при оценке фильтра метрик. Псевдонимы: filter_tag | |
| id строка / обязательно | Идентификатор, используемый для идентификации конфигурации метрик. | |
| profile строка | Использует профиль boto. Работает только с boto >= 2.24.0. Использование profile переопределит aws_access_key, aws_secret_key и security_token. Поддержка одновременной передачи этих параметров с profile устарела. aws_access_key, aws_secret_key и security_token будут взаимоисключающими с profile после 2022-06-01. Псевдонимы: aws_profile | |
| region строка | AWS-регион для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
Псевдонимы: aws_region, ec2_region | |
| security_token строка | AWS STS security token. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если задан параметр profile, этот параметр игнорируется. Передача параметров security_token и profile одновременно устарела и параметры станут взаимоисключающими после 2022-06-01. Псевдонимы: aws_security_token, access_token | |
| state строка |
| Создание или удаление конфигурации метрик |
| validate_certs логический тип |
| Если установлено в "нет", SSL-сертификаты не будут проверены для версий boto >= 2.6.0. |
Примечания
Примечание
- Этот модуль управляет одной конфигурацией метрик, ведро s3 может иметь до 1000 конфигураций метрик
- Для запроса метрик для всего ведра создайте конфигурацию метрик без фильтра
- Конфигурации метрик необходимы только для включения метрик запросов, метрики ежедневного хранения на уровне ведра всегда включены
- Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета
AWS_URLилиEC2_URL,AWS_PROFILEилиAWS_DEFAULT_PROFILE,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,AWS_CA_BUNDLE - Ansible использует файл конфигурации boto (как правило, ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONможно использовать для указания AWS региона, когда это необходимо, но это также можно настроить в файле конфигурации boto
Примеры
# Note: These examples do not set authentication details, see the AWS Guide for details.
- name: Create a metrics configuration that enables metrics for an entire bucket
community.aws.s3_metrics_configuration:
bucket_name: my-bucket
id: EntireBucket
state: present
- name: Put a metrics configuration that enables metrics for objects starting with a prefix
community.aws.s3_metrics_configuration:
bucket_name: my-bucket
id: Assets
filter_prefix: assets
state: present
- name: Put a metrics configuration that enables metrics for objects with specific tag
community.aws.s3_metrics_configuration:
bucket_name: my-bucket
id: Assets
filter_tag:
kind: asset
state: present
- name: Put a metrics configuration that enables metrics for objects that start with a particular prefix and have specific tags applied
community.aws.s3_metrics_configuration:
bucket_name: my-bucket
id: ImportantBlueDocuments
filter_prefix: documents
filter_tags:
priority: high
class: blue
state: present
- name: Delete metrics configuration
community.aws.s3_metrics_configuration:
bucket_name: my-bucket
id: EntireBucket
state: absent
Авторы
- Dmytro Vorotyntsev (@vorotech)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/aws/s3_metrics_configuration_module.html
