Spec-Zone.ru › AWS CLI v2

[ aws . ram ]

create-resource-share

Описание

Создаёт ресурсный общий доступ. Вы можете указать список Amazon Resource Names (ARN) ресурсов, которые вы хотите предоставить в общий доступ, список принципалов, с которыми вы хотите предоставить доступ к ресурсам, и разрешения, которые вы хотите предоставить этим принципалам.

Примечание

Предоставление ресурса в общий доступ делает его доступным для использования принципалами за пределами учётной записи Amazon Web Services, которая создала ресурс. Предоставление в общий доступ не изменяет разрешения или квоты, которые применяются к ресурсу в учётной записи, которая его создала.

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

Синтаксис

  create-resource-share
--name <value>
[--resource-arns <value>]
[--principals <value>]
[--tags <value>]
[--allow-external-principals | --no-allow-external-principals]
[--client-token <value>]
[--permission-arns <value>]
[--sources <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]

Параметры

--name (строка)

Указывает имя ресурсного общего доступа.

--resource-arns (список)

Указывает список одного или нескольких ARNs ресурсов, которые нужно связать с ресурсным общим доступом.

(строка)

Синтаксис:

"string" "string" ...

--principals (список)

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

Вы можете указать следующие значения:

  • Идентификатор учётной записи Amazon Web Services, например: 123456789012
  • Amazon Resource Name (ARN) организации в Organizations, например: organizations::123456789012:organization/o-exampleorgid
  • ARN организационной единицы (OU) в Organizations, например: organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
  • ARN роли IAM, например: iam::123456789012:role/rolename
  • ARN пользователя IAM, например: iam::123456789012user/username

Примечание

Не все типы ресурсов могут быть предоставлены в общий доступ с ролями и пользователями IAM. Дополнительную информацию см. в разделе «Предоставление в общий доступ с ролями и пользователями IAM» в руководстве пользователя Resource Access Manager.

(строка)

Синтаксис:

"string" "string" ...

--tags (список)

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

(структура)

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

Дополнительную информацию о тегах см. в разделе «Использование тегов для ресурсов Amazon Web Services» в руководстве по продуктам Amazon Web Services.

key -> (строка)

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

value -> (строка)

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

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

key=string,value=string ...

Синтаксис JSON:

[
  {
    "key": "string",
    "value": "string"
  }
  ...
]

--allow-external-principals | --no-allow-external-principals (логическое значение)

Указывает, могут ли принципалы за пределами вашей организации в Organizations быть связаны с ресурсным общим доступом. Значение true позволяет предоставлять доступ учётным записям Amazon Web Services, которые не являются частью вашей организации. Значение false имеет смысл только в том случае, если ваша учётная запись является членом организации Amazon Web Services. Значение по умолчанию — true.

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

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

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

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

--permission-arns (список)

Указывает Amazon Resource Names (ARN) разрешений RAM, которые необходимо связать с ресурсным общим доступом. Если вы не укажете ARN для разрешения, RAM автоматически присоединит стандартную версию разрешения для каждого типа ресурса. Вы можете связать только одно разрешение с каждым типом ресурса, включённым в ресурсный общий доступ.

(строка)

Синтаксис:

"string" "string" ...

--sources (список)

Указывает, из каких источников учётных записей служба-принципал имеет доступ к ресурсам в этом ресурсном общем доступе.

(строка)

Синтаксис:

"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
  • текст
  • таблица
  • 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.

Примеры

Примечание

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

Если не указано иное, все примеры имеют правила цитирования, похожие на unix-подобные. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной среды. Дополнительную информацию см. в разделе «Использование кавычек со строками» в руководстве пользователя AWS CLI.

Пример 1: Создание ресурсного общего доступа

Следующий create-resource-share пример создаёт пустой ресурсный общий доступ с указанным именем. Вы должны отдельно добавить ресурсы, принципалов и разрешения к общему доступу.

aws ram create-resource-share \
    --name MyNewResourceShare

Вывод:

{
    "resourceShare": {
        "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/4476c27d-8feb-4b21-afe9-7de23EXAMPLE",
        "name": "MyNewResourceShare",
        "owningAccountId": "123456789012",
        "allowExternalPrincipals": true,
        "status": "ACTIVE",
        "creationTime": 1634586271.302,
        "lastUpdatedTime": 1634586271.302
    }
}

Пример 2: Создание ресурсного общего доступа с учётными записями AWS в качестве принципалов

Следующий create-resource-share пример создаёт ресурсный общий доступ и предоставляет доступ указанной учётной записи AWS (222222222222). Если указанные принципалы не являются частью одной и той же организации AWS, то отправляются приглашения, которые должны быть приняты перед предоставлением доступа.

aws ram create-resource-share \
    --name MyNewResourceShare \
    --principals 222222222222

Пример 3: Создание ресурсного общего доступа, ограниченного вашей организацией AWS

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

aws ram create-resource-share \
    --name MyNewResourceShare \
    --no-allow-external-principals \
    --principals arn:aws:organizations::123456789012:ou/o-63bEXAMPLE/ou-46xi-rEXAMPLE

Вывод:

{
    "resourceShare": {
        "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/7be8694e-095c-41ca-9ce8-7be4aEXAMPLE",
        "name": "MyNewResourceShare",
        "owningAccountId": "123456789012",
        "allowExternalPrincipals": false,
        "status": "ACTIVE",
        "creationTime": 1634587042.49,
        "lastUpdatedTime": 1634587042.49
    }
}

Вывод

resourceShare -> (структура)

Объект с информацией о новом ресурсном обмене.

resourceShareArn -> (строка)

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

name -> (строка)

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

owningAccountId -> (строка)

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

allowExternalPrincipals -> (булево)

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

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

status -> (строка)

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

statusMessage -> (строка)

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

tags -> (список)

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

(структура)

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

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

key -> (строка)

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

value -> (строка)

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

creationTime -> (метка времени)

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

lastUpdatedTime -> (метка времени)

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

featureSet -> (строка)

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

  • 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 -> (строка)

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

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

Spec-Zone.ru

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