[ aws . storagegateway ]
describe-nfs-file-shares
Описание
Получает описание одного или нескольких сетевых файловых ресурсов NFS (Network File System) со шлюза S3 File Gateway. Данная операция поддерживается только для шлюзов S3 File Gateway.
См. также: Документация AWS API
Синтаксис
describe-nfs-file-shares
--file-share-arn-list <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]
Параметры
--file-share-arn-list (список)
Массив, содержащий Amazon Resource Name (ARN) каждого файлового ресурса NFS, описание которого требуется.
(строка)
Синтаксис:
"string" "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 (логическое значение)
Включить отладочную запись в журнал.
--endpoint-url (строка)
Переопределить значение по умолчанию URL команды на указанный URL.
--no-verify-ssl (логическое значение)
По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.
--no-paginate (логическое значение)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования вывода команды.
- json
- text
- таблица
- yaml
- yaml-поток
--query (строка)
JMESPath-запрос для фильтрации данных ответа.
--profile (строка)
Использовать определенный профиль из файла учетных данных.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (строка)
Отобразить версию данного инструмента.
--color (строка)
Включить/выключить цветной вывод.
- включить
- выключить
- авто
--no-sign-request (логическое значение)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.
--ca-bundle (строка)
Пакет сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.
--cli-read-timeout (целое число)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться без блокировки и без таймаута. Значение по умолчанию — 60 секунд.
--cli-connect-timeout (целое число)
Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет выполняться без блокировки и без таймаута. Значение по умолчанию — 60 секунд.
--cli-binary-format (строка)
Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичное и будет использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного формата cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (логическое значение)
Отключить вывод пейджера CLI.
--cli-auto-prompt (логическое значение)
Автоматически запросить параметры входных данных CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматический запрос параметров входных данных CLI.
Вывод
NFSFileShareInfoList -> (список)
Массив, содержащий описание каждого запрошенного сетевого файлового ресурса.
(структура)
Права и информация об авторстве Unix, которые по умолчанию назначаются объектам S3 при обнаружении их в S3-бакетах файловым шлюзом S3. Данная операция поддерживается только для файловых шлюзов S3.
NFSFileShareDefaults -> (структура)
Описывает значения по умолчанию для сетевого файлового ресурса NFS (Network File System). Файлы и папки, хранящиеся как объекты Amazon S3 в S3-бакетах, по умолчанию не имеют назначенных прав Unix. При обнаружении в S3-бакете шлюзом Storage Gateway, объектам S3, представляющим файлы и папки, назначаются эти значения по умолчанию для прав Unix. Данная операция поддерживается только для файловых шлюзов S3.
FileMode -> (строка)
0666 представляет собой режим файла по умолчанию внутри файлового ресурса. Значение по умолчанию - 0666 .DirectoryMode -> (строка)
0666 представляет собой режим доступа по умолчанию для всех каталогов внутри файлового ресурса. Значение по умолчанию - 0777 .GroupId -> (целое число)
nfsnobody .OwnerId -> (целое число)
nfsnobody .FileShareARN -> (строка)
FileShareId -> (строка)
FileShareStatus -> (строка)
Состояние файлового ресурса.
Допустимые значения: CREATING | UPDATING | AVAILABLE | DELETING
GatewayARN -> (строка)
EncryptionType -> (строка)
Значение, определяющее тип шифрования на стороне сервера, который будет использоваться файловым ресурсом для данных, хранящихся в Amazon S3.
Примечание
Рекомендуется использовать EncryptionType вместо KMSEncrypted для настройки метода шифрования файлового ресурса. Вам не нужно указывать значения для обоих параметров.
Если значения для обоих параметров существуют в одном запросе, то указанные методы шифрования не должны противоречить друг другу. Например, если EncryptionType является SseS3, то KMSEncrypted должно быть false. Если EncryptionType является SseKms или DsseKms, то KMSEncrypted должно быть true.
KMSEncrypted -> (булево)
Необязательно. Установите значение true для использования шифрования Amazon S3 на стороне сервера с вашим собственным ключом KMS (SSE-KMS) или false для использования ключа, управляемого Amazon S3 (SSE-S3). Для использования двухслойного шифрования (DSSE-KMS) установите параметр EncryptionType вместо этого.
Примечание
Рекомендуется использовать EncryptionType вместо KMSEncrypted для настройки метода шифрования файлового ресурса. Вам не нужно указывать значения для обоих параметров.
Если значения для обоих параметров существуют в одном запросе, то указанные методы шифрования не должны противоречить друг другу. Например, если EncryptionType является SseS3, то KMSEncrypted должно быть false. Если EncryptionType является SseKms или DsseKms, то KMSEncrypted должно быть true.
Допустимые значения: true | false
KMSKey -> (строка)
KMSEncrypted является true, или если EncryptionType является SseKms или DsseKms.Path -> (строка)
Role -> (строка)
LocationARN -> (строка)
Настраиваемый ARN для базового хранилища, используемого для хранения данных для файловых ресурсов. Он включает ARN ресурса с необязательным префиксом, добавленным в начало. Префикс должен заканчиваться слешем (/).
Примечание
Вы можете указать LocationARN как ARN ведра, ARN точки доступа или псевдоним точки доступа, как показано в следующих примерах.
ARN ведра:
arn:aws:s3:::amzn-s3-demo-bucket/prefix/ARN точки доступа:
arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/Если вы указываете точку доступа, политика ведра должна быть настроена для делегирования управления доступом к точке доступа. Дополнительная информация приведена в разделе «Делегирование управления доступом к точкам доступа» в Руководстве пользователя Amazon S3.
Псевдоним точки доступа:
test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3aliasDefaultStorageClass -> (строка)
Класс хранилища по умолчанию для объектов, помещенных в ведро Amazon S3 файловым шлюзом S3. Значение по умолчанию - S3_STANDARD. Необязательно.
Допустимые значения: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA
ObjectACL -> (строка)
private .ClientList -> (список)
Список клиентов, которым разрешен доступ к файловому шлюзу S3. Список должен содержать либо допустимые IP-адреса, либо допустимые CIDR-блоки.
(строка)
Squash -> (строка)
Пользователь, сопоставленный анонимному пользователю. Допустимые варианты:
-
RootSquash: Только корень сопоставляется с анонимным пользователем. -
NoSquash: Никто не сопоставляется с анонимным пользователем. -
AllSquash: Все сопоставляются с анонимным пользователем.
ReadOnly -> (булево)
Значение, устанавливающее статус записи файлового ресурса. Установите значение true для установки статуса записи на чтение только, в противном случае установите значение false.
Допустимые значения: true | false
GuessMIMETypeEnabled -> (булево)
Значение, которое включает угадывание типа MIME для загружаемых объектов на основе расширений файлов. Установите значение true для включения угадывания типа MIME, в противном случае установите значение false. Значение по умолчанию - true.
Допустимые значения: true | false
RequesterPays -> (булево)
Значение, определяющее, кто оплачивает стоимость запроса и стоимости загрузки данных из S3-ведрa. Если это значение установлено в true, пользователь оплачивает расходы, в противном случае - владелец S3-ведрa. Однако владелец S3-ведрa всегда оплачивает стоимость хранения данных.
Примечание
RequesterPays является настройкой S3-ведрa, которое является основой для файлового ресурса, поэтому убедитесь, что настройка в файловом ресурсе совпадает с настройкой в S3-ведре.Допустимые значения: true | false
Tags -> (список)
Список из до 50 тегов, назначенных файловому ресурсу NFS, отсортированный в алфавитном порядке по имени ключа. Каждый тег - это пара «ключ-значение». Для шлюза с более чем 10 назначенными тегами вы можете просмотреть все теги, используя операцию API ListTagsForResource.
(структура)
Пара «ключ-значение», которая помогает управлять, фильтровать и искать ваши ресурсы. Разрешенные символы: буквы, пробелы и цифры, представляемые в UTF-8, и следующие символы: + - = . _ : /.
Key -> (строка)
Value -> (строка)
FileShareName -> (строка)
Имя файлового ресурса. Необязательно.
Примечание
FileShareName должен быть установлен, если имя префикса S3 установлено в LocationARN, или если используется точка доступа или псевдоним точки доступа.CacheAttributes -> (структура)
Информация о кэшировании для файлового ресурса.
CacheStaleTimeoutInSeconds -> (целое число)
Обновляет кэш файлового ресурса с использованием времени жизни (TTL). TTL - это время с момента последнего обновления, после которого доступ к каталогу заставит файловый шлюз сначала обновить содержимое этого каталога из ведра Amazon S3 или файловой системы Amazon FSx. Продолжительность TTL указана в секундах.
Допустимые значения: 0, от 300 до 2 592 000 секунд (от 5 минут до 30 дней)
NotificationPolicy -> (строка)
Политика уведомлений для файлового ресурса. SettlingTimeInSeconds управляет количеством секунд ожидания после последней точки во времени, когда клиент записывал в файл, прежде чем генерировать уведомление ObjectUploaded. Поскольку клиенты могут выполнять много небольших записей в файлы, лучше всего установить этот параметр как можно дольше, чтобы избежать генерации нескольких уведомлений для одного файла в короткий промежуток времени.
Примечание
SettlingTimeInSeconds не влияет на время загрузки объекта в Amazon S3, а только на время отправки уведомления.Это значение не предназначено для указания точного времени отправки уведомления. В некоторых случаях шлюзу может потребоваться больше времени, чем указанный интервал ожидания, для генерации и отправки уведомлений.
Следующий пример включает NotificationPolicy со значением SettlingTimeInSeconds равным 60.
{\"Upload\": {\"SettlingTimeInSeconds\": 60}}Следующий пример выключает NotificationPolicy.
{}VPCEndpointDNSName -> (строка)
Указывает имя DNS для точки входа VPC, которую использует файловый ресурс NFS для подключения к Amazon S3.
Примечание
Этот параметр необходим для файловых ресурсов NFS, которые подключаются к Amazon S3 через точку входа VPC, точку доступа VPC или псевдоним точки доступа, указывающий на точку доступа VPC.BucketRegion -> (строка)
Указывает регион S3-ведрa, в котором файловый ресурс NFS хранит файлы.
Примечание
Этот параметр необходим для файловых ресурсов NFS, которые подключаются к Amazon S3 через точку входа VPC, точку доступа VPC или псевдоним точки доступа, указывающий на точку доступа VPC.AuditDestinationARN -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.