Spec-Zone.ru › AWS CLI v2

[ aws . ec2 ]

modify-ipam-resource-discovery

Описание

Изменяет обнаружение ресурсов. Обнаружение ресурсов — это компонент IPAM, который позволяет IPAM управлять и контролировать ресурсы, принадлежащие учетной записи-владельцу.

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

Синтаксис

  modify-ipam-resource-discovery
[--dry-run | --no-dry-run]
--ipam-resource-discovery-id <value>
[--description <value>]
[--add-operating-regions <value>]
[--remove-operating-regions <value>]
[--add-organizational-unit-exclusions <value>]
[--remove-organizational-unit-exclusions <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]

Параметры

--dry-run | --no-dry-run (boolean)

Проверяет наличие необходимых разрешений для действия, не отправляя фактический запрос и возвращая ответ об ошибке. Если разрешения есть, ответ об ошибке — DryRunOperation. В противном случае — UnauthorizedOperation.

--ipam-resource-discovery-id (string)

Идентификатор обнаружения ресурсов.

--description (string)

Описание обнаружения ресурсов.

--add-operating-regions (list)

Добавление регионов работы к обнаружению ресурсов. Регионы работы — это регионы Amazon Web Services, в которых IPAM разрешено управлять CIDR-блоками IP-адресов. IPAM обнаруживает и контролирует ресурсы только в тех регионах Amazon Web Services, которые выбраны в качестве регионов работы.

(структура)

Добавление региона работы к IPAM. Регионы работы — это регионы Amazon Web Services, в которых IPAM разрешено управлять CIDR-блоками IP-адресов. IPAM обнаруживает и контролирует ресурсы только в тех регионах Amazon Web Services, которые выбраны в качестве регионов работы.

Дополнительную информацию о регионах работы см. в разделе Создание IPAM в руководстве Amazon VPC IPAM User Guide.

RegionName -> (string)

Название региона работы.

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

RegionName=string ...

Синтаксис JSON:

[
  {
    "RegionName": "string"
  }
  ...
]

--remove-operating-regions (list)

Удаление регионов работы.

(структура)

Удаление региона работы из IPAM. Регионы работы — это регионы Amazon Web Services, в которых IPAM разрешено управлять CIDR-блоками IP-адресов. IPAM обнаруживает и контролирует ресурсы только в тех регионах Amazon Web Services, которые выбраны в качестве регионов работы.

Дополнительную информацию о регионах работы см. в разделе Создание IPAM в руководстве Amazon VPC IPAM User Guide.

RegionName -> (string)

Название региона работы, который требуется удалить.

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

RegionName=string ...

Синтаксис JSON:

[
  {
    "RegionName": "string"
  }
  ...
]

--add-organizational-unit-exclusions (list)

Добавление исключения организационной единицы (OU) в IPAM. Если IPAM интегрирован с Amazon Web Services Organizations и вы добавляете исключение организационной единицы (OU), IPAM не будет управлять IP-адресами в учётных записях в этом исключении OU. Есть ограничение на количество исключений, которые можно создать. Дополнительную информацию см. в разделе Квоты для IPAM в руководстве Amazon VPC IPAM User Guide.

Примечание

Результат набора исключений не должен содержать «перекрытий», то есть два или более исключения OU не должны исключать одну и ту же OU. Дополнительную информацию и примеры см. в процессе запроса Amazon Web Services CLI в разделе Добавление или удаление исключений OU в руководстве Amazon VPC User Guide.

(структура)

Добавление исключения организационной единицы (OU) в IPAM. Если IPAM интегрирован с Amazon Web Services Organizations и вы добавляете исключение организационной единицы (OU), IPAM не будет управлять IP-адресами в учётных записях в этом исключении OU. Есть ограничение на количество исключений, которые можно создать. Дополнительную информацию см. в разделе Квоты для IPAM в руководстве Amazon VPC IPAM User Guide.

OrganizationsEntityPath -> (string)

Путь сущности Amazon Web Services Organizations. Сформируйте путь для OU(s) с использованием идентификаторов Amazon Web Services Organizations, разделенных /. Включите все дочерние OU, завершив путь /*.

  • Пример 1
    • Путь к дочерней OU: o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-ghi0-awsccccc/ou-jkl0-awsddddd/
    • В этом примере o-a1b2c3d4e5 — идентификатор организации, r-f6g7h8i9j0example — корневой идентификатор, ou-ghi0-awsccccc — идентификатор OU, и ou-jkl0-awsddddd — идентификатор дочерней OU.
    • IPAM не будет управлять IP-адресами в учётных записях в дочерней OU.
  • Пример 2
    • Путь, где все дочерние OU будут частью исключения: o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-ghi0-awsccccc/*
    • В этом примере IPAM не будет управлять IP-адресами в учётных записях в OU (ou-ghi0-awsccccc) или в учётных записях в любых OU, являющихся дочерними по отношению к OU.

Дополнительную информацию о том, как построить путь сущности, см. в разделе Понимание пути сущности Amazon Web Services Organizations в руководстве Amazon Web Services Identity and Access Management User Guide.

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

OrganizationsEntityPath=string ...

Синтаксис JSON:

[
  {
    "OrganizationsEntityPath": "string"
  }
  ...
]

--remove-organizational-unit-exclusions (list)

Удаление исключения организационной единицы (OU) из IPAM. Если IPAM интегрирован с Amazon Web Services Organizations и вы добавляете исключение организационной единицы (OU), IPAM не будет управлять IP-адресами в учётных записях в этом исключении OU. Есть ограничение на количество исключений, которые можно создать. Дополнительную информацию см. в разделе Квоты для IPAM в руководстве Amazon VPC IPAM User Guide.

Примечание

Результат набора исключений не должен содержать «перекрытий», то есть два или более исключения OU не должны исключать одну и ту же OU. Дополнительную информацию и примеры см. в процессе запроса Amazon Web Services CLI в разделе Добавление или удаление исключений OU в руководстве Amazon VPC User Guide.

(структура)

Удаление исключения организационной единицы (OU) из IPAM. Если IPAM интегрирован с Amazon Web Services Organizations и вы добавляете исключение организационной единицы (OU), IPAM не будет управлять IP-адресами в учётных записях в этом исключении OU. Есть ограничение на количество исключений, которые можно создать. Дополнительную информацию см. в разделе Квоты для IPAM в руководстве Amazon VPC IPAM User Guide.

OrganizationsEntityPath -> (string)

Путь сущности Amazon Web Services Organizations. Сформируйте путь для OU(s) с использованием идентификаторов Amazon Web Services Organizations, разделенных /. Включите все дочерние OU, завершив путь /*.

  • Пример 1
    • Путь к дочерней OU: o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-ghi0-awsccccc/ou-jkl0-awsddddd/
    • В этом примере o-a1b2c3d4e5 — идентификатор организации, r-f6g7h8i9j0example — корневой идентификатор, ou-ghi0-awsccccc — идентификатор OU, и ou-jkl0-awsddddd — идентификатор дочерней OU.
    • IPAM не будет управлять IP-адресами в учётных записях в дочерней OU.
  • Пример 2
    • Путь, где все дочерние OU будут частью исключения: o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-ghi0-awsccccc/*
    • В этом примере IPAM не будет управлять IP-адресами в учётных записях в OU (ou-ghi0-awsccccc) или в учётных записях в любых OU, являющихся дочерними по отношению к OU.

Дополнительную информацию о том, как построить путь сущности, см. в разделе Понимание пути сущности Amazon Web Services Organizations в руководстве Amazon Web Services Identity and Access Management User Guide.

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

OrganizationsEntityPath=string ...

Синтаксис JSON:

[
  {
    "OrganizationsEntityPath": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Чтение аргументов из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного JSON, поскольку строка будет воспринята буквально. Это может не быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (string) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено значение без значения или значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, оно выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно валидирует входные данные команды и возвращает пример выходного JSON для данной команды. Сгенерированный JSON-скелет нестабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Общие параметры

--debug (boolean)

Включить отладовую запись журнала.

--endpoint-url (string)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI проверяет сертификаты SSL. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определённый профиль из файла учетных данных.

--region (string)

Регион для использования. Переопределяет настройки из конфигурации/среды.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (string)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки из конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет выполняться в блокирующем режиме без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет выполняться в блокирующем режиме без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования для бинарных блоков. Формат по умолчанию — 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 (boolean)

Отключить вывод страницы CLI.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Примеры

Примечание

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

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

Изменение регионов работы обнаружения ресурсов

В этом примере вы, администратор IPAM, делегированный для управления, хотите изменить регионы работы обнаружения ресурсов.

Для выполнения этого запроса:

  • Вы не можете изменить обнаружение ресурсов по умолчанию, и вы должны быть владельцем обнаружения ресурсов.
  • Вам необходим ID обнаружения ресурсов, который вы можете получить с помощью describe-ipam-resource-discoveries.

Следующий modify-ipam-resource-discovery пример изменяет обнаружение ресурсов, отличное от обнаружения по умолчанию, в вашей учётной записи AWS.

aws ec2 modify-ipam-resource-discovery \
    --ipam-resource-discovery-id ipam-res-disco-0f4ef577a9f37a162 \
    --add-operating-regions RegionName='us-west-1' \
    --remove-operating-regions RegionName='us-east-2' \
    --region us-east-1

Вывод:

{
    "IpamResourceDiscovery": {
        "OwnerId": "149977607591",
        "IpamResourceDiscoveryId": "ipam-res-disco-0365d2977fc1672fe",
        "IpamResourceDiscoveryArn": "arn:aws:ec2::149977607591:ipam-resource-discovery/ipam-res-disco-0365d2977fc1672fe",
        "IpamResourceDiscoveryRegion": "us-east-1",
        "Description": "Example",
        "OperatingRegions": [
            {
                "RegionName": "us-east-1"
            },
            {
                "RegionName": "us-west-1"
            }
        ],
        "IsDefault": false,
        "State": "modify-in-progress"
    }
}

Дополнительную информацию см. в разделе Работа с обнаружениями ресурсов в руководстве пользователя Amazon VPC IPAM.

Вывод

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

Обнаружение ресурсов.

OwnerId -> (строка)

Идентификатор владельца.

IpamResourceDiscoveryId -> (строка)

Идентификатор обнаружения ресурсов.

IpamResourceDiscoveryArn -> (строка)

Amazon Resource Name (ARN) обнаружения ресурсов.

IpamResourceDiscoveryRegion -> (строка)

Регион обнаружения ресурсов.

Description -> (строка)

Описание обнаружения ресурсов.

OperatingRegions -> (список)

Регионы работы для обнаружения ресурсов. Регионы работы — это регионы Amazon Web Services, в которых IPAM разрешено управлять CIDR-блоками IP-адресов. IPAM обнаруживает и отслеживает ресурсы только в тех регионах Amazon Web Services, которые вы выбираете в качестве регионов работы.

(структура)

Регионы работы для IPAM. Регионы работы — это регионы Amazon Web Services, в которых IPAM разрешено управлять CIDR-блоками IP-адресов. IPAM обнаруживает и отслеживает ресурсы только в тех регионах Amazon Web Services, которые вы выбираете в качестве регионов работы.

Дополнительную информацию о регионах работы см. в разделе Создание IPAM в руководстве пользователя Amazon VPC IPAM.

RegionName -> (строка)

Название региона работы.

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

Определяет, является ли обнаружение ресурсов обнаружением по умолчанию. Обнаружение ресурсов по умолчанию — это обнаружение ресурсов, автоматически созданное при создании IPAM.

State -> (строка)

Состояние жизненного цикла обнаружения ресурсов.

  • create-in-progress - Обнаружение ресурсов создается.
  • create-complete - Создание обнаружения ресурсов завершено.
  • create-failed - Создание обнаружения ресурсов завершилось ошибкой.
  • modify-in-progress - Обнаружение ресурсов изменяется.
  • modify-complete - Изменение обнаружения ресурсов завершено.
  • modify-failed - Изменение обнаружения ресурсов завершилось ошибкой.
  • delete-in-progress - Обнаружение ресурсов удаляется.
  • delete-complete - Удаление обнаружения ресурсов завершено.
  • delete-failed - Удаление обнаружения ресурсов завершилось ошибкой.
  • isolate-in-progress - Учётная запись Amazon Web Services, создавшая обнаружение ресурсов, была удалена, и обнаружение ресурсов изолируется.
  • isolate-complete - Изоляция обнаружения ресурсов завершена.
  • restore-in-progress - Учётная запись Amazon Web Services, создавшая и изолировавшая обнаружение ресурсов, была восстановлена.

Tags -> (список)

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

(структура)

Описание тега.

Key -> (строка)

Ключ тега.

Ограничения: ключи тегов чувствительны к регистру и принимают максимум 127 символов Юникода. Не может начинаться с aws:.

Value -> (строка)

Значение тега.

Ограничения: значения тегов чувствительны к регистру и принимают максимум 256 символов Юникода.

OrganizationalUnitExclusions -> (список)

Если ваш IPAM интегрирован с Amazon Web Services Organizations, и вы добавляете исключение организационной единицы (OU), IPAM не будет управлять IP-адресами в учетных записях в этом исключении OU.

(структура)

Если ваш IPAM интегрирован с Amazon Web Services Organizations, и вы добавляете исключение организационной единицы (OU), IPAM не будет управлять IP-адресами в учетных записях в этом исключении OU.

OrganizationsEntityPath -> (строка)

Путь к сущности Amazon Web Services Organizations. Дополнительную информацию о пути сущности см. в разделе Понимание пути сущности Amazon Web Services Organizations в руководстве пользователя Amazon Web Services Identity and Access Management.

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

Spec-Zone.ru

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