community.aws.efs модуль — создание и поддержка файловых систем EFS

Примечание

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

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

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

Для использования в книге задач укажите: community.aws.efs.

Новое в community.aws 1.0.0

Описание
Требования
Параметры
Примечания
Примеры
Значения возврата

Описание

Модуль позволяет создавать, искать и удалять файловые системы Amazon EFS.

Требования

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

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

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key строка	ID ключа доступа 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 для проверки сертификатов 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` обратный вызов для вывода в общий список, созданный во время выполнения плейбука. Также может использоваться переменная среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Выбори: `false` ← (по умолчанию) `true`
encrypt булево	Если encrypt=true, создаёт зашифрованный файловый сервер. Это нельзя изменить после создания файлового сервера. Выбори: `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.
id строка	ID Amazon EFS. Для удаления требуется имя или ID.
kms_key_id строка	ID AWS KMS CMK, который будет использоваться для защиты зашифрованного файлового сервера. Этот параметр необходим только если вы хотите использовать нестандартный CMK. Если этот параметр не указан, используется стандартный CMK для Amazon EFS. Идентификатор ключа может быть идентификатором ключа, ARN ключа, псевдонимом ключа или ARN псевдонима ключа.
name строка	Токен создания файловой системы Amazon EFS. Требуется для создания и обновления. Для удаления требуется имя или ID.
performance_mode строка	Режим производительности файловой системы. Действует только при создании. Выбори: `"general_purpose"` ← (по умолчанию) `"max_io"`
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.
provisioned_throughput_in_mibps вещественное число	Если throughput_mode = provisioned, выберите пропускную способность в Мбит/с.
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 aliases: aws_region, ec2_region string	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 aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key string	Секретный ключ доступа 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.
session_token aliases: aws_session_token, security_token, aws_security_token, access_token string	Токен сеанса 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`, `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.
state string	Разрешает создавать, искать и удалять файловые системы Amazon EFS. Варианты: `"present"` ← (по умолчанию) `"absent"`
tags aliases: resource_tags dictionary	Список тегов Amazon EFS. Должен быть определен как словарь. В случае состояния ‘present’ со списком тегов и существующей EFS (совпадающей по имени), теги EFS будут заменены предоставленными данными.
targets list / elements=dictionary	Список подключенных целевых устройств. Он должен быть списком словарей, каждый словарь должен содержать следующие атрибуты: Эти данные могут быть изменены для существующей EFS с помощью состояния ‘present’ и нового списка целевых устройств. По умолчанию: `[]`
ip_address string	Действительный IPv4-адрес в диапазоне адресов указанной подсети.
security_groups list / elements=string	Список идентификаторов групп безопасности в формате ‘sg-xxxxxxxx’. Они должны относиться к той же VPC, что и указанная подсеть.
subnet_id string / обязательно	Идентификатор подсети для добавления целевого устройства.
throughput_mode string	Режим пропускной способности для создаваемой файловой системы. Варианты: `"bursting"` `"provisioned"`
transition_to_ia string добавлено в community.aws 2.1.0	Количество дней, в течение которых объекты будут переведены в хранилище EFS Infrequent Access (IA) с более низкой стоимостью. Если установлено значение `None`, любая существующая политика жизненного цикла будет удалена, и объекты не будут переведены в хранилище IA. Если этот параметр отсутствует, любая существующая политика жизненного цикла не будет затронута. Варианты: `"None"` `"7"` `"14"` `"30"` `"60"` `"90"`
validate_certs boolean	Если установлено значение `false`, сертификаты SSL для связи с API AWS не будут проверены. Настройка validate_certs=false категорически не рекомендуется. В качестве альтернативы, следует настроить aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)
wait boolean	В случае состояния ‘present’ следует ожидать состояние жизненного цикла EFS ‘available’ (конечно, если текущее состояние не ‘deleting’ или ‘deleted’). В случае состояния ‘absent’ следует ожидать состояние жизненного цикла EFS ‘deleted’. Варианты: `false` ← (по умолчанию) `true`

wait_timeout

integer

Сколько времени модуль должен ждать (в секундах) желаемого состояния, прежде чем возвращать результат. Ноль означает ждать столько, сколько необходимо.

Default: 0

Примечания

Примечание

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

Примеры

- name: EFS provisioning
  community.aws.efs:
    state: present
    name: myTestEFS
    tags:
      Name: myTestNameTag
      purpose: file-storage
    targets:
      - subnet_id: subnet-748c5d03
        security_groups: ["sg-1a2b3c4d"]

- name: Modifying EFS data
  community.aws.efs:
    state: present
    name: myTestEFS
    tags:
      name: myAnotherTestTag
    targets:
      - subnet_id: subnet-7654fdca
        security_groups: ["sg-4c5d6f7a"]

- name: Set a lifecycle policy
  community.aws.efs:
    state: present
    name: myTestEFS
    transition_to_ia: 7
    targets:
      - subnet_id: subnet-7654fdca
        security_groups: ["sg-4c5d6f7a"]

- name: Remove a lifecycle policy
  community.aws.efs:
    state: present
    name: myTestEFS
    transition_to_ia: None
    targets:
      - subnet_id: subnet-7654fdca
        security_groups: ["sg-4c5d6f7a"]

- name: Deleting EFS
  community.aws.efs:
    state: absent
    name: myTestEFS

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

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

Ключ	Описание
creation_time string	метка времени даты создания Возвращается: всегда Пример: `"2015-11-16 07:30:57-05:00"`
creation_token string	Токен создания EFS Возвращается: всегда Пример: `"console-88609e04-9a0e-4a2e-912c-feaa99509961"`
file_system_id string	ID файловой системы Возвращается: всегда Пример: `"fs-xxxxxxxx"`
filesystem_address string	URL файловой системы, допустимый для использования с монтированием Возвращается: всегда Пример: `"fs-xxxxxxxx.efs.us-west-2.amazonaws.com:/"`
life_cycle_state string	состояние файловой системы EFS Возвращается: всегда Пример: `"creating, available, deleting, deleted"`
mount_point string	URL файловой системы с ведущей точкой со времени, когда AWS EFS требовалось добавлять суффикс региона к адресу Возвращается: всегда Пример: `".fs-xxxxxxxx.efs.us-west-2.amazonaws.com:/"`
mount_targets list / elements=string	список точек монтирования Возвращается: всегда Пример: `[{"file_system_id": "fs-a7ad440e", "ip_address": "172.31.17.173", "life_cycle_state": "available", "mount_target_id": "fsmt-d8907871", "network_interface_id": "eni-6e387e26", "owner_id": "123456789012", "security_groups": ["sg-a30b22c6"], "subnet_id": "subnet-e265c895"}, "..."]`
name string	имя файловой системы Возвращается: всегда Пример: `"my-efs"`
number_of_mount_targets integer	количество смонтированных точек Возвращается: всегда Пример: `3`
owner_id string	ID учетной записи AWS владельца EFS Возвращается: всегда Пример: `"XXXXXXXXXXXX"`
performance_mode string	режим производительности файловой системы Возвращается: всегда Пример: `"generalPurpose"`
size_in_bytes dictionary	размер файловой системы в байтах по состоянию на метку времени Возвращается: всегда Пример: `{"timestamp": "2015-12-21 13:59:59-05:00", "value": 12288}`
tags dictionary	теги на экземпляре efs Возвращается: всегда Пример: `{"key": "Value", "name": "my-efs"}`

Авторы

Ryan Sydnor (@ryansydnor)
Artem Kazakov (@akazakov)

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

© 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/community/aws/efs_module.html