Spec-Zone.ru › AWS CLI v2

[ aws . efs ]

create-file-system

Описание

Создаёт новый пустой файловый сервер. Для операции требуется маркер создания в запросе, который Amazon EFS использует для обеспечения идемпотентности создания (вызов операции с тем же маркером создания не имеет эффекта). Если файловый сервер в настоящее время не существует и принадлежит учётной записи вызывающего Amazon Web Services с указанным маркером создания, эта операция выполняет следующие действия:

  • Создаёт новый пустой файловый сервер. Файловый сервер будет иметь назначенный Amazon EFS идентификатор и начальное состояние жизненного цикла creating.
  • Возвращает описание созданного файлового сервера.

В противном случае эта операция возвращает ошибку FileSystemAlreadyExists с идентификатором существующего файлового сервера.

Примечание

Для простых случаев использования вы можете использовать случайный сгенерированный UUID для маркера создания.

Идемпотентная операция позволяет повторно выполнить CreateFileSystem вызов без риска создания дополнительного файлового сервера. Это может произойти, когда начальный вызов завершается таким образом, что неясно, был ли файловый сервер на самом деле создан. Примером может служить таймаут транспортного уровня или сброс соединения. Пока вы используете тот же маркер создания, если начальный вызов успешно создал файловый сервер, клиент может узнать о его существовании по ошибке FileSystemAlreadyExists.

Дополнительную информацию см. в разделе Создание файлового сервера в Руководстве пользователя Amazon EFS .

Примечание

CreateFileSystem вызов возвращается, пока состояние жизненного цикла файлового сервера по-прежнему creating. Вы можете проверить состояние создания файлового сервера, вызвав операцию DescribeFileSystems, которая, среди прочего, возвращает состояние файлового сервера.

Эта операция принимает необязательный PerformanceMode параметр, который вы выбираете для своего файлового сервера. Мы рекомендуем generalPurpose PerformanceMode для всех файловых серверов. Режим maxIO — это предыдущий тип производительности, предназначенный для высокопараллельных рабочих нагрузок, которые могут терпеть более высокие задержки, чем режим generalPurpose. Режим MaxIO не поддерживается для файловых серверов одной зоны или файловых серверов, использующих упругий пропуск.

PerformanceMode не может быть изменён после создания файлового сервера. Дополнительную информацию см. в разделе Режимы производительности Amazon EFS .

Вы можете установить режим пропускной способности для файлового сервера, используя параметр ThroughputMode.

После того, как файловый сервер будет полностью создан, Amazon EFS установит его состояние жизненного цикла в available, в этот момент вы можете создать одну или несколько целевых точек подключения для файлового сервера в вашей VPC. Дополнительную информацию см. в разделе CreateMountTarget. Вы подключаетесь к файловому серверу Amazon EFS на экземплярах EC2 в вашей VPC, используя целевую точку подключения. Дополнительную информацию см. в разделе Amazon EFS: Как это работает .

Для этой операции требуются разрешения на действие elasticfilesystem:CreateFileSystem.

Файловые серверы могут быть помечены при создании. Если теги указаны в операции создания, IAM выполняет дополнительный авторизацию действия elasticfilesystem:TagResource, чтобы проверить, имеют ли пользователи разрешения на создание тегов. Поэтому вы должны предоставить явные разрешения для использования действия elasticfilesystem:TagResource. Дополнительную информацию см. в разделе Назначение разрешений для тегов ресурсов при создании .

См. также: Документация API AWS

Синтаксис

  create-file-system
[--creation-token <value>]
[--performance-mode <value>]
[--encrypted | --no-encrypted]
[--kms-key-id <value>]
[--throughput-mode <value>]
[--provisioned-throughput-in-mibps <value>]
[--availability-zone-name <value>]
[--backup | --no-backup]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--creation-token (строка)

Строка длиной до 64 ASCII-символов. Amazon EFS использует её для обеспечения идемпотентности создания.

--performance-mode (строка)

Режим производительности файлового сервера. Мы рекомендуем generalPurpose режим производительности для всех файловых серверов. Файловые серверы, использующие режим производительности maxIO, могут масштабироваться до более высоких уровней агрегированной пропускной способности и операций в секунду с компромиссом в виде несколько более высоких задержек для большинства операций с файлами. Режим производительности нельзя изменить после создания файлового сервера. Режим maxIO не поддерживается для файловых серверов одной зоны.

Предупреждение

Из-за более высоких задержек на операцию Max I/O мы рекомендуем использовать режим производительности General Purpose для всех файловых серверов.

По умолчанию generalPurpose.

Возможные значения:

  • generalPurpose
  • maxIO

--encrypted | --no-encrypted (булево)

Булево значение, которое, если равно true, создаёт зашифрованный файловый сервер. При создании зашифрованного файлового сервера у вас есть возможность указать существующий ключ управления ключами (KMS-ключ). Если вы не укажете KMS-ключ, то по умолчанию используется KMS-ключ для Amazon EFS, /aws/elasticfilesystem, для защиты зашифрованного файлового сервера.

--kms-key-id (строка)

Идентификатор KMS-ключа, который вы хотите использовать для защиты зашифрованного файлового сервера. Этот параметр требуется только если вы хотите использовать KMS-ключ, отличный от стандартного. Если этот параметр не указан, используется стандартный KMS-ключ для Amazon EFS. Вы можете указать ID KMS-ключа в следующих форматах:

  • Идентификатор ключа — уникальный идентификатор ключа, например 1234abcd-12ab-34cd-56ef-1234567890ab.
  • ARN — Amazon Resource Name (ARN) для ключа, например arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
  • Псевдоним ключа — ранее созданное имя для ключа, например alias/projectKey1.
  • ARN псевдонима ключа — ARN для псевдонима ключа, например arn:aws:kms:us-west-2:444455556666:alias/projectKey1.

Если вы используете KmsKeyId, вы должны установить параметр CreateFileSystemRequest$Encrypted в значение true.

Предупреждение

EFS принимает только симметричные KMS-ключи. Вы не можете использовать асимметричные KMS-ключи с файловыми системами Amazon EFS.

--throughput-mode (строка)

Устанавливает режим пропускной способности файлового сервера. Режим может быть bursting, provisioned или elastic. Если вы устанавливаете ThroughputMode в provisioned, вы также должны установить значение для ProvisionedThroughputInMibps. После создания файлового сервера вы можете уменьшить пропускную способность с выделенной пропускной способностью или переключиться между режимами пропускной способности, с некоторыми ограничениями по времени. Дополнительную информацию см. в разделе Указание пропускной способности с выделенным режимом в Руководстве пользователя Amazon EFS.

По умолчанию bursting.

Возможные значения:

  • bursting
  • provisioned
  • elastic

--provisioned-throughput-in-mibps (двойное число)

Пропускная способность, измеряемая в мебибайтах в секунду (Мбит/с), которую вы хотите выделить для создаваемого файлового сервера. Требуется, если ThroughputMode установлено в provisioned. Допустимые значения составляют от 1 до 3414 Мбит/с, причём верхний предел зависит от региона. Для увеличения этого предела обратитесь в службу поддержки Amazon Web Services. Дополнительную информацию см. в разделе Квоты Amazon EFS, которые можно увеличить, в Руководстве пользователя Amazon EFS.

--availability-zone-name (строка)

Для файловых серверов одной зоны укажите зону доступности Amazon Web Services, в которой нужно создать файловый сервер. Используйте формат us-east-1a для указания зоны доступности. Дополнительную информацию о файловых серверах одной зоны см. в разделе Типы файловых систем EFS в Руководстве пользователя Amazon EFS.

Примечание

Файловые серверы одной зоны недоступны во всех зонах доступности в регионах Amazon Web Services, где доступна Amazon EFS.

--backup | --no-backup (булево)

Указывает, включены ли автоматические резервные копии для файлового сервера, который вы создаёте. Установите значение в true, чтобы включить автоматические резервные копии. Если вы создаёте файловый сервер одной зоны, автоматические резервные копии включены по умолчанию. Дополнительную информацию см. в разделе Автоматические резервные копии в Руководстве пользователя Amazon EFS.

По умолчанию false. Однако, если вы укажете AvailabilityZoneName, по умолчанию будет true.

Примечание

Резервное копирование недоступно во всех регионах Amazon Web Services, где доступен Amazon EFS.

--tags (список)

Используйте для создания одного или нескольких тегов, связанных с файловым сервером. Каждый тег — это пользовательская пара «ключ-значение». Назовите файловый сервер при создании, включив пару «ключ-значение» "Key":"Name","Value":"{value}". Каждый ключ должен быть уникальным. Дополнительную информацию см. в разделе Помечение ресурсов Amazon Web Services в Общей справочной документации Amazon Web Services.

(структура)

Тег — это пара «ключ-значение». Допустимые символы — буквы, пробелы и цифры, которые можно представить в UTF-8, а также следующие символы:+ - = . _ : /.

Ключ -> (строка)

Ключ тега (строка). Ключ не может начинаться с aws:.

Значение -> (строка)

Значение ключа тега.

Сокращённый синтаксис:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения перепишут значения, предоставленные JSON. Невозможно передать произвольные двоичные значения с помощью значения, предоставленного JSON, так как строка будет воспринята буквально. Это может не быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит каркас JSON в стандартный вывод без отправки запроса API. Если предоставлено без значения или со значением input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, оно выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно проверяет входные данные команд и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-каркас не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-каркасе.

Общие параметры

--debug (boolean)

Включить отладку логирования.

--endpoint-url (string)

Переопределить URL по умолчанию команды на указанный URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один запрос для первой страницы результатов.

--output (string)

Стиль форматирования вывода команд.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определённый профиль из файла аутентификации.

--region (string)

Регион для использования. Переопределяет настройки из конфигурации/окружения.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Данные аутентификации не будут загружены, если этот аргумент указан.

--ca-bundle (string)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки из конфигурации/окружения.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде закодированной строки base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку fileb://, всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (boolean)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматическое запросы параметров ввода CLI.

Примеры

Примечание

Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Подробнее см. руководство по началу работы в руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования в стиле Unix. Эти примеры потребуется адаптировать к правилам цитирования вашей оболочки терминала. См. использование кавычек с строками в руководстве пользователя AWS CLI.

Для создания зашифрованного файлового хранилища

Следующий create-file-system пример создаёт зашифрованное файловое хранилище, используя по умолчанию CMK. Он также добавляет тег Name=my-file-system.

aws efs create-file-system \
    --performance-mode generalPurpose \
    --throughput-mode bursting \
    --encrypted \
    --tags Key=Name,Value=my-file-system

Вывод:

{
    "OwnerId": "123456789012",
    "CreationToken": "console-d7f56c5f-e433-41ca-8307-9d9c0example",
    "FileSystemId": "fs-c7a0456e",
    "FileSystemArn": "arn:aws:elasticfilesystem:us-west-2:123456789012:file-system/fs-48499b4d",
    "CreationTime": 1595286880.0,
    "LifeCycleState": "creating",
    "Name": "my-file-system",
    "NumberOfMountTargets": 0,
    "SizeInBytes": {
        "Value": 0,
        "ValueInIA": 0,
        "ValueInStandard": 0
    },
    "PerformanceMode": "generalPurpose",
    "Encrypted": true,
    "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/a59b3472-e62c-42e4-adcf-30d92example",
    "ThroughputMode": "bursting",
    "Tags": [
        {
            "Key": "Name",
            "Value": "my-file-system"
        }
    ]
}

Дополнительную информацию см. в руководстве пользователя Amazon Elastic File System по созданию файловых систем Amazon EFS.

Вывод

OwnerId -> (string)

AWS-аккаунт, создавший файловую систему.

CreationToken -> (string)

Непрозрачная строка, указанная в запросе.

FileSystemId -> (string)

Идентификатор файловой системы, назначенный Amazon EFS.

FileSystemArn -> (string)

Amazon Resource Name (ARN) для файловой системы EFS в формате arn:aws:elasticfilesystem:*region* :*account-id* :file-system/*file-system-id* `` . Example with sample data: ``arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567

CreationTime -> (timestamp)

Время создания файловой системы в секундах (с 1970-01-01T00:00:00Z).

LifeCycleState -> (string)

Этап жизненного цикла файловой системы.

Name -> (string)

Вы можете добавить теги к файловой системе, включая тег Name. Дополнительную информацию см. в CreateFileSystem. Если файловая система имеет тег Name, Amazon EFS возвращает значение в этом поле.

NumberOfMountTargets -> (integer)

Текущее количество целевых точек подключения к файловой системе. Дополнительную информацию см. в CreateMountTarget.

SizeInBytes -> (structure)

Последний известный размер (в байтах) данных, хранящихся в файловой системе, в поле Value и время определения этого размера в поле Timestamp. Значение Timestamp — целое число секунд с 1970-01-01T00:00:00Z. Значение SizeInBytes не представляет собой размер последовательной «снимки» файловой системы, но оно согласованно, если в файловую систему нет записей. То есть, SizeInBytes представляет фактический размер только в том случае, если файловая система не изменяется в течение нескольких часов. В противном случае, значение не является точным размером файловой системы в любой момент времени.

Value -> (long)

Последний известный размер (в байтах) данных, хранящихся в файловой системе.

Timestamp -> (timestamp)

Время, когда был определен размер данных, возвращенный в поле Value. Значение — целое число секунд с 1970-01-01T00:00:00Z.

ValueInIA -> (long)

Последний известный размер (в байтах) данных, хранящихся в хранилище Infrequent Access.

ValueInStandard -> (long)

Последний известный размер (в байтах) данных, хранящихся в хранилище Standard.

ValueInArchive -> (long)

Последний известный размер (в байтах) данных, хранящихся в хранилище Archive.

PerformanceMode -> (string)

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

Encrypted -> (boolean)

Логическое значение, которое, если равно true, указывает, что файловая система зашифрована.

KmsKeyId -> (string)

Идентификатор ключа KMS, используемого для защиты зашифрованной файловой системы.

ThroughputMode -> (string)

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

ProvisionedThroughputInMibps -> (double)

Количество предоставленной пропускной способности в MiBps для файловой системы. Действительно для файловых систем, где ThroughputMode установлено в provisioned.

AvailabilityZoneName -> (string)

Описание Amazon Web Services зоны доступности, в которой расположена файловая система, и действительна только для файловых систем в одной зоне. Дополнительную информацию см. в руководстве пользователя Amazon EFS по использованию классов хранилища EFS.

AvailabilityZoneId -> (string)

Уникальный и согласованный идентификатор зоны доступности, в которой расположена файловая система, и действителен только для файловых систем в одной зоне. Например, use1-az1 — идентификатор зоны доступности для Amazon Web Services региона us-east-1, и он имеет одинаковое расположение во всех аккаунтах Amazon Web Services.

Tags -> (list)

Теги, связанные с файловой системой, представленные в виде массива объектов Tag.

(structure)

Тег — это пара ключ-значение. Разрешённые символы — буквы, пробелы и цифры, которые могут быть представлены в UTF-8, а также следующие символы: + - = . _ : /.

Key -> (string)

Ключ тега (строка). Ключ не может начинаться с aws:.

Value -> (string)

Значение ключа тега.

FileSystemProtection -> (structure)

Описание защиты файловой системы.

ReplicationOverwriteProtection -> (string)

Статус защиты от перезаписи при репликации файловой системы.

  • ENABLED – Файловая система не может быть использована в качестве файловой системы назначения в конфигурации репликации. Файловая система доступна для записи. Защита от перезаписи при репликации по умолчанию — ENABLED.
  • DISABLED – Файловая система может быть использована в качестве файловой системы назначения в конфигурации репликации. Файловая система доступна только для чтения и может быть изменена только репликацией EFS.
  • REPLICATING – Файловая система используется в качестве файловой системы назначения в конфигурации репликации. Файловая система доступна только для чтения и изменяется только репликацией EFS.

Если конфигурация репликации удалена, защита от перезаписи при репликации файловой системы восстанавливается, и файловая система становится доступной для записи.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

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