Spec-Zone.ru › AWS CLI v2

[ aws . ram ]

associate-resource-share

Описание

Добавляет указанный список принципалов и список ресурсов к ресурсному обмену. Принципалы, которые уже имеют доступ к этому ресурсному обмену, немедленно получат доступ к добавленным ресурсам. Новые добавленные принципалы немедленно получат доступ к ресурсам, общим в этом ресурсном обмене.

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

Синтаксис

  associate-resource-share
--resource-share-arn <value>
[--resource-arns <value>]
[--principals <value>]
[--client-token <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]

Параметры

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

Указывает Amazon Resource Name (ARN) ресурсного обмена, к которому вы хотите добавить принципалов или ресурсы.

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

Указывает список Amazon Resource Names (ARN) ресурсов, которые вы хотите разделить. Это может быть null, если вы хотите добавить только принципалов.

(строка)

Синтаксис:

"string" "string" ...

--principals (список)

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

Что принципалы могут делать с ресурсами в обмене, определяется разрешениями RAM, которые вы связываете с ресурсным обменом. См. AssociateResourceSharePermission.

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

  • Идентификатор учетной записи 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" ...

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

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

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

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

--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 в разделе «Начало работы».

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

Пример 1: Чтобы связать ресурс с ресурсным обменом

Следующий associate-resource-share пример добавляет конфигурацию лицензии к указанному ресурсному обмену.

aws ram associate-resource-share \
    --resource-share arn:aws:ram:us-west-2:123456789012:resource-share/27d09b4b-5e12-41d1-a4f2-19dedEXAMPLE \
    --resource-arns arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-36be0485f5ae379cc74cf8e92EXAMPLE

Вывод:

{
    "resourceShareAssociations": [
        {
           "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/27d09b4b-5e12-41d1-a4f2-19dedEXAMPLE",
           "associatedEntity": "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-36be0485f5ae379cc74cf8e92EXAMPLE",
           "associationType": "RESOURCE",
           "status": "ASSOCIATING",
           "external": false
        }
    ]
}

Пример 2: Чтобы связать принципал с ресурсным обменом

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

aws ram associate-resource-share \
    --resource-share-arn arn:aws:ram:us-west-2:123456789012:resource-share/27d09b4b-5e12-41d1-a4f2-19dedEXAMPLE \
    --principals arn:aws:organizations::123456789012:ou/o-63bEXAMPLE/ou-46xi-rEXAMPLE

Вывод:

{
    "resourceShareAssociations": [
        {
            "status": "ASSOCIATING",
            "associationType": "PRINCIPAL",
            "associatedEntity": "arn:aws:organizations::123456789012:ou/o-63bEXAMPLE/ou-46xi-rEXAMPLE",
            "external": false,
            "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/27d09b4b-5e12-41d1-a4f2-19dedEXAMPLE"
        }
    ]
}

Вывод

resourceShareAssociations -> (список)

Массив объектов, содержащих информацию об ассоциациях.

(структура)

Описание ассоциации между ресурсным обменом и принципалом или ресурсом.

resourceShareArn -> (строка)

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

resourceShareName -> (строка)

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

associatedEntity -> (строка)

Связанный элемент. Это может быть одно из следующего:

  • Для ассоциации ресурсов это Amazon Resource Name (ARN) ресурса.
  • Для ассоциаций принципалов это одно из следующего:
    • Идентификатор учетной записи Amazon Web Services
    • Amazon Resource Name (ARN) организации в Organizations
    • ARN организационной единицы (OU) в Organizations
    • ARN роли IAM
    • ARN пользователя IAM

associationType -> (строка)

Тип элемента, включенного в эту ассоциацию.

status -> (строка)

Текущий статус ассоциации.

statusMessage -> (строка)

Сообщение о статусе ассоциации.

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

Дата и время создания ассоциации.

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

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

external -> (логическое значение)

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

clientToken -> (строка)

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

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

Spec-Zone.ru

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