Spec-Zone.ru › AWS CLI v2

[ aws . ram ]

обновить-общий-ресурс

Описание

Изменяет некоторые свойства указанного общего ресурса.

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

Синтаксис

  update-resource-share
--resource-share-arn <value>
[--name <value>]
[--allow-external-principals | --no-allow-external-principals]
[--client-token <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]

Параметры

--resource-share-arn (строка)

Указывает Amazon Resource Name (ARN) общего ресурса, который требуется изменить.

--name (строка)

При указании - новое имя, которое требуется присвоить общему ресурсу.

--allow-external-principals | --no-allow-external-principals (булево)

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

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

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

Если вы не предоставите это значение, Amazon Web Services сгенерирует случайное значение для вас.

Если вы повторно отправляете операцию с тем же ClientToken, но с другими параметрами, повторная попытка завершается ошибкой IdempotentParameterMismatch.

--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 для вывода.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

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

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

Для обновления общего ресурса

Следующий update-resource-share пример изменяет указанный общий ресурс, чтобы разрешить внешние принципы, которые не входят в AWS Организацию.

aws ram update-resource-share \
    --allow-external-principals \
    --resource-share-arn arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE

Вывод:

{
    "resourceShare": {
        "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE",
        "name": "my-resource-share",
        "owningAccountId": "123456789012",
        "allowExternalPrincipals": true,
        "status": "ACTIVE",
        "creationTime": 1565295733.282,
        "lastUpdatedTime": 1565303080.023
    }
}

Вывод

общийРесурс -> (структура)

Информация об общем ресурсе.

arnОбщегоРесурса -> (строка)

Amazon Resource Name (ARN) общего ресурса

имя -> (строка)

Имя общего ресурса.

идентификаторВладеющегоАккаунта -> (строка)

ID аккаунта Amazon Web Services, владеющего общим ресурсом.

разрешитьВнешнихПринципов -> (булево)

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

  • True — общий ресурс может быть предоставлен любому аккаунту Amazon Web Services.
  • False — общий ресурс может быть предоставлен только аккаунтам в той же организации, что и аккаунт, владеющий общим ресурсом.

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

Текущее состояние общего ресурса.

сообщениеОСостоянии -> (строка)

Сообщение о состоянии общего ресурса.

метки -> (список)

Ключи и значения тегов, прикрепленные к общему ресурсу.

(структура)

Структура, содержащая тег. Тег — это метаданные, которые вы можете прикрепить к своим ресурсам, чтобы помочь организовать и классифицировать их. Вы также можете использовать их для повышения безопасности ваших ресурсов. Дополнительная информация — в разделе Управление доступом к ресурсам Amazon Web Services с помощью тегов.

Дополнительная информация о тегах — в разделе Тегирование ресурсов Amazon Web Services в Справочном руководстве по общим ресурсам Amazon Web Services.

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

Ключ или имя, прикреплённые к тегу. Каждый тег должен иметь ключ. Имена ключей чувствительны к регистру.

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

Строковое значение, прикрепленное к тегу. Значение может быть пустой строкой. Значения ключей чувствительны к регистру.

времяСоздание -> (временная метка)

Дата и время создания общего ресурса.

последнееОбновление -> (временная метка)

Дата и время последнего обновления общего ресурса.

наборФункций -> (строка)

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

  • **STANDARD** — общий ресурс, который поддерживает все функции. Эти общие ресурсы видны всем принципам, с которыми вы разделяете общий ресурс. Вы можете изменять эти общие ресурсы в RAM с помощью консоли или API. Этот общий ресурс мог быть создан RAM, или он мог быть **CREATED_FROM_POLICY**, а затем повышен.
  • **CREATED_FROM_POLICY** — клиент вручную поделился ресурсом, прикрепив политику, основанную на ресурсе. Эта политика не соответствовала существующим управляемым разрешениям, поэтому RAM автоматически создал эти управляемые клиентом разрешения от имени клиента на основе документа политики, прикрепленного к нему. Этот тип общего ресурса виден только аккаунту Amazon Web Services, который его создал. Вы не можете изменить его в RAM, пока не поднимите его статус. Дополнительная информация — в разделе PromoteResourceShareCreatedFromPolicy.
  • **PROMOTING_TO_STANDARD** — Этот общий ресурс первоначально был CREATED_FROM_POLICY, но клиент запустил PromoteResourceShareCreatedFromPolicy, и эта операция ещё выполняется. Это значение изменится на STANDARD при завершении.

токКлиента -> (строка)

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

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

Spec-Zone.ru

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