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

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

encrypt

логическое значение

Если задано значение encrypt=true, создается зашифрованная файловая система. Изменить это значение после создания файловой системы нельзя.

Варианты:

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

endpoint_url

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

строка

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

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

id

строка

Идентификатор Amazon EFS. Для удаления необходимо указать имя или идентификатор.

kms_key_id

строка

Идентификатор главного ключа клиента AWS KMS (CMK), используемого для защиты зашифрованной файловой системы. Этот параметр требуется, только если необходимо использовать нестандартный CMK. Если параметр не указан, используется CMK по умолчанию для Amazon EFS. В качестве идентификатора ключа можно указать Key ID, Key ID ARN, Key Alias или Key Alias ARN.

name

строка

Токен создания файловой системы Amazon EFS. Обязателен при создании и обновлении. Для удаления необходимо указать имя или идентификатор.

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 и session_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

псевдонимы: 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

строка

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

Варианты:

• "present" ← (по умолчанию)
• "absent"

tags

псевдонимы: resource_tags

словарь

Список тегов Amazon EFS. Должен быть задан в виде словаря. Если состояние «present» и передан список тегов для существующей EFS (найденной по «name»), теги EFS будут заменены указанными.

targets

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

Список целевых точек монтирования. Это должен быть список словарей, каждый из которых должен содержать следующие атрибуты. Эти данные можно изменить для существующей EFS, установив состояние «present» и передав новый список целевых точек монтирования.

По умолчанию: []

ip_address

строка

Допустимый IPv4-адрес из диапазона адресов указанной подсети.

security_groups

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

Список идентификаторов групп безопасности в формате «sg-xxxxxxxx». Они должны относиться к той же VPC, что и указанная подсеть.

subnet_id

строка / обязательный

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

throughput_mode

строка

Режим пропускной способности создаваемой файловой системы.

Варианты:

• "bursting"
• "provisioned"

transition_to_ia

строка

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

Через сколько дней объекты переходят в класс хранилища EFS Infrequent Access (IA) с более низкой стоимостью.

Если задано строковое значение None, все существующие политики жизненного цикла будут удалены, и объекты не будут переходить в класс хранилища IA.

Если этот параметр не указан, существующая политика жизненного цикла не изменяется.

Варианты:

• "None"
• "7"
• "14"
• "30"
• "60"
• "90"

validate_certs

логическое значение

Если задано значение false, SSL-сертификаты при взаимодействии с API AWS проверяться не будут.

Настоятельно не рекомендуется устанавливать validate_certs=false; вместо этого рассмотрите возможность настройки aws_ca_bundle.

Варианты:

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

wait

логическое значение

При состоянии «present» ожидать, пока жизненный цикл EFS не перейдет в состояние «available» (если текущее состояние не «deleting» и не «deleted»). При состоянии «absent» ожидать, пока жизненный цикл EFS не перейдет в состояние «deleted».

Варианты:

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

wait_timeout

целое число

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

По умолчанию: 0

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

идентификатор файловой системы

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

Пример: "fs-xxxxxxxx"

filesystem_address

string

URL файловой системы, пригодный для использования с mount

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

Пример: "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

идентификатор учетной записи 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"}