update-smb-file-share

Описание

Обновляет сетевую папку общего доступа SMB (Server Message Block). Данная операция поддерживается только для шлюзов S3 File Gateways.

Примечание

Чтобы оставить поле общего доступа к файлам без изменений, установите соответствующее поле ввода в null.

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

Для создания сетевой папки общего доступа шлюзы файлов требуют активации службы Security Token Service (Amazon Web Services STS). Убедитесь, что служба Amazon Web Services STS активирована в регионе Amazon Web Services, где вы создаёте шлюз файлов. Если служба Amazon Web Services STS не активирована в данном регионе Amazon Web Services, активируйте её. Сведения об активации службы Amazon Web Services STS см. в руководстве по работе с IAM (Identity and Access Management) в разделе «Активация и деактивация Amazon Web Services STS в регионе Amazon Web Services».

Шлюзы файлов не поддерживают создание жёстких или символических ссылок в сетевой папке общего доступа.

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

Синтаксис

  update-smb-file-share
--file-share-arn <value>
[--encryption-type <value>]
[--kms-encrypted | --no-kms-encrypted]
[--kms-key <value>]
[--default-storage-class <value>]
[--object-acl <value>]
[--read-only | --no-read-only]
[--guess-mime-type-enabled | --no-guess-mime-type-enabled]
[--requester-pays | --no-requester-pays]
[--smbacl-enabled | --no-smbacl-enabled]
[--access-based-enumeration | --no-access-based-enumeration]
[--admin-user-list <value>]
[--valid-user-list <value>]
[--invalid-user-list <value>]
[--audit-destination-arn <value>]
[--case-sensitivity <value>]
[--file-share-name <value>]
[--cache-attributes <value>]
[--notification-policy <value>]
[--oplocks-enabled | --no-oplocks-enabled]
[--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 (строка)

Идентификатор ресурса Amazon (ARN) общего доступа к файлам SMB, который требуется обновить.

--encryption-type (строка)

Значение, определяющее тип шифрования на стороне сервера, который общий доступ к файлам будет использовать для данных, хранящихся в Amazon S3.

Примечание

Рекомендуется использовать EncryptionType вместо KMSEncrypted для установки метода шифрования общего доступа к файлам. Вам не нужно предоставлять значения для обоих параметров.

Если значения для обоих параметров существуют в одном запросе, то указанные методы шифрования не должны противоречить друг другу. Например, если EncryptionType — SseS3, то KMSEncrypted должно быть false. Если EncryptionType — SseKms или DsseKms, то KMSEncrypted должно быть true.

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

SseS3
SseKms
DsseKms

--kms-encrypted | --no-kms-encrypted (логическое)

Необязательно. Установите значение true, чтобы использовать шифрование Amazon S3 на стороне сервера с собственным ключом KMS (SSE-KMS), или false, чтобы использовать ключ, управляемый Amazon S3 (SSE-S3). Для использования двухслойного шифрования (DSSE-KMS), установите параметр EncryptionType вместо него.

Примечание

Допустимые значения: true | false

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

Необязательно. Идентификатор ресурса Amazon (ARN) симметричного ключа главного мастера (CMK), используемого для шифрования на стороне сервера Amazon S3. Storage Gateway не поддерживает асимметричные CMK. Это значение должно быть установлено, если KMSEncrypted равно true, или если EncryptionType равно SseKms или DsseKms.

--default-storage-class (строка)

Стандартное хранилище для объектов, помещаемых в ведро Amazon S3 с помощью S3 File Gateway. Значение по умолчанию — S3_STANDARD. Необязательно.

Допустимые значения: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

--object-acl (строка)

Значение, устанавливающее разрешения списка управления доступом (ACL) для объектов в ведре S3, в которое S3 File Gateway помещает объекты. Значение по умолчанию — private.

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

private
public-read
public-read-write
authenticated-read
bucket-owner-read
bucket-owner-full-control
aws-exec-read

--read-only | --no-read-only (логическое)

Значение, устанавливающее статус записи для общего доступа к файлам. Установите это значение в true, чтобы установить статус записи в режим только для чтения, в противном случае установите в false.

Допустимые значения: true | false

--guess-mime-type-enabled | --no-guess-mime-type-enabled (логическое)

Значение, которое позволяет угадать тип MIME для загружаемых объектов на основе расширений файлов. Установите это значение в true, чтобы включить угадывание типа MIME, в противном случае установите в false. Значение по умолчанию — true.

Допустимые значения: true | false

--requester-pays | --no-requester-pays (логическое)

Значение, устанавливающее, кто оплачивает затраты на запрос и затраты, связанные с загрузкой данных из ведра S3. Если это значение установлено в true, запрос оплачивает пользователь; в противном случае — владелец ведра S3. Однако владелец ведра S3 всегда оплачивает затраты на хранение данных.

Примечание

RequesterPays — это конфигурация ведра S3, которое поддерживает общий доступ к файлам, поэтому убедитесь, что конфигурация общего доступа к файлам такая же, как и конфигурация ведра S3.

Допустимые значения: true | false

--smbacl-enabled | --no-smbacl-enabled (логическое)

Установите это значение в true, чтобы включить список управления доступом (ACL) для общего доступа к файлам SMB. Установите в false, чтобы отобразить разрешения на файлы и каталоги в разрешения POSIX.

Дополнительную информацию см. в разделе Использование списков управления доступом Windows для ограничения доступа к общему доступу к файлам SMB в Руководстве пользователя Amazon S3 File Gateway.

Допустимые значения: true | false

--access-based-enumeration | --no-access-based-enumeration (логическое)

Файлы и папки в этом общем доступе будут видны только пользователям с правами на чтение.

--admin-user-list (список)

Список пользователей или групп в Active Directory, имеющих права администратора на общий доступ к файлам. Группа должна быть префиксной символом @. Приемлемые форматы включают: DOMAIN\User1, user1, @group1 и @DOMAIN\group1. Может быть установлено только в том случае, если Аутентификация установлена в ActiveDirectory.

(строка)

Синтаксис:

"string" "string" ...

--valid-user-list (список)

Список пользователей или групп в Active Directory, которым разрешен доступ к общему доступу к файлам. Группа должна быть префиксной символом @. Приемлемые форматы включают: DOMAIN\User1, user1, @group1 и @DOMAIN\group1. Может быть установлено только в том случае, если Аутентификация установлена в ActiveDirectory.

(строка)

Синтаксис:

"string" "string" ...

--invalid-user-list (список)

Список пользователей или групп в Active Directory, которым запрещен доступ к общему доступу к файлам. Группа должна быть префиксной символом @. Приемлемые форматы включают: DOMAIN\User1, user1, @group1 и @DOMAIN\group1. Может быть установлено только в том случае, если Аутентификация установлена в ActiveDirectory.

(строка)

Синтаксис:

"string" "string" ...

--audit-destination-arn (строка)

Идентификатор ресурса Amazon (ARN) хранилища, используемого для аудиторских журналов.

--case-sensitivity (строка)

Регистр имени объекта в ведре Amazon S3. Для ClientSpecified клиент определяет чувствительность к регистру. Для CaseSensitive шлюз определяет чувствительность к регистру. Значение по умолчанию — ClientSpecified.

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

ClientSpecified
CaseSensitive

--file-share-name (строка)

Имя общего доступа к файлам. Необязательно.

Примечание

FileShareName должен быть установлен, если имя префикса S3 задано в LocationARN или если используется точка доступа или псевдоним точки доступа.

Действительное имя общего доступа к файлам SMB не может содержать следующие символы: [, ``]`` ,``#`` ,``;`` ,``<`` ,``>`` ,``:`` ,``”`` ,```` ,``/`` ,``|`` ,``?`` ,``*`` ,``+`` или управляющие символы ASCII 1-31 .

--cache-attributes (структура)

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

CacheStaleTimeoutInSeconds -> (целое число)

Обновляет кэш общего доступа к файлам, используя время жизни (TTL). TTL — это продолжительность времени с момента последнего обновления, после которой доступ к каталогу заставит файловый шлюз сначала обновить содержимое этого каталога из ведра Amazon S3 или файловой системы Amazon FSx. Продолжительность TTL в секундах.

Допустимые значения: 0, от 300 до 2 592 000 секунд (от 5 минут до 30 дней)

Упрощенный синтаксис:

CacheStaleTimeoutInSeconds=integer

Синтаксис JSON:

{
  "CacheStaleTimeoutInSeconds": integer
}

--notification-policy (строка)

Политика уведомлений общего доступа к файлам. SettlingTimeInSeconds управляет количеством секунд ожидания после последней точки во времени, когда клиент записал в файл, перед генерацией уведомления ObjectUploaded. Поскольку клиенты могут выполнять множество мелких записей в файлы, лучше всего установить этот параметр как можно дольше, чтобы избежать генерации нескольких уведомлений для одного файла в короткий промежуток времени.

Примечание

SettlingTimeInSeconds не влияет на время загрузки объекта в Amazon S3, а только на время отправки уведомления.

Это значение не должно указывать точное время, в которое будет отправлено уведомление. В некоторых случаях шлюз может потребовать больше времени, чем указанный временной интервал, для генерации и отправки уведомлений.

Следующий пример устанавливает NotificationPolicy с SettlingTimeInSeconds, установленным в 60.

{\"Upload\": {\"SettlingTimeInSeconds\": 60}}

Следующий пример устанавливает NotificationPolicy выключенным.

{}

--oplocks-enabled | --no-oplocks-enabled (логическое)

Указывает, включена ли опциональная блокировка для общего доступа к файлам SMB.

Примечание

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

Допустимые значения: true | false

--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
текст
таблица
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-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

FileShareARN -> (строка)

Amazon Resource Name (ARN) обновлённого SMB-совместно используемого файла.