create-ipam-resource-discovery
Описание
Создаёт открытие ресурсов IPAM. Открытие ресурсов — это компонент IPAM, который позволяет IPAM управлять и контролировать ресурсы, принадлежащие учётной записи-владельцу.
См. также: Документацию API AWS
Синтаксис
create-ipam-resource-discovery
[--dry-run | --no-dry-run]
[--description <value>]
[--operating-regions <value>]
[--tag-specifications <value>]
[--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]
Параметры
--dry-run | --no-dry-run (boolean)
DryRunOperation. В противном случае — UnauthorizedOperation.--description (string)
--operating-regions (list)
Рабочие регионы для открытия ресурсов IPAM. Рабочие регионы — это регионы 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 -> (string)
Краткая форма синтаксиса:
RegionName=string ...
Синтаксис JSON:
[
{
"RegionName": "string"
}
...
]
--tag-specifications (list)
Спецификации тегов для открытия ресурсов IPAM.
(структура)
Теги, которые необходимо применить к ресурсу при создании. Если вы указываете тег, вы должны указать тип ресурса для тегирования; в противном случае запрос завершится ошибкой.
Примечание
СписокValid Values содержит все типы ресурсов, которые можно тегировать. Однако используемое действие может не поддерживать тегирование всех этих типов ресурсов. Если вы попытаетесь тегировать тип ресурса, который не поддерживается используемым действием, вы получите ошибку.ResourceType -> (string)
Tags -> (list)
Теги, которые необходимо применить к ресурсу.
(структура)
Описание тега.
Key -> (string)
Ключ тега.
Ограничения: ключи тегов чувствительны к регистру и принимают не более 127 символов Юникода. Не должны начинаться с aws:.
Value -> (string)
Значение тега.
Ограничения: значения тегов чувствительны к регистру и принимают не более 256 символов Юникода.
Краткая форма синтаксиса:
ResourceType=string,Tags=[{Key=string,Value=string},{Key=string,Value=string}] ...
Синтаксис JSON:
[
{
"ResourceType": "capacity-reservation"|"client-vpn-endpoint"|"customer-gateway"|"carrier-gateway"|"coip-pool"|"declarative-policies-report"|"dedicated-host"|"dhcp-options"|"egress-only-internet-gateway"|"elastic-ip"|"elastic-gpu"|"export-image-task"|"export-instance-task"|"fleet"|"fpga-image"|"host-reservation"|"image"|"import-image-task"|"import-snapshot-task"|"instance"|"instance-event-window"|"internet-gateway"|"ipam"|"ipam-pool"|"ipam-scope"|"ipv4pool-ec2"|"ipv6pool-ec2"|"key-pair"|"launch-template"|"local-gateway"|"local-gateway-route-table"|"local-gateway-virtual-interface"|"local-gateway-virtual-interface-group"|"local-gateway-route-table-vpc-association"|"local-gateway-route-table-virtual-interface-group-association"|"natgateway"|"network-acl"|"network-interface"|"network-insights-analysis"|"network-insights-path"|"network-insights-access-scope"|"network-insights-access-scope-analysis"|"outpost-lag"|"placement-group"|"prefix-list"|"replace-root-volume-task"|"reserved-instances"|"route-table"|"security-group"|"security-group-rule"|"service-link-virtual-interface"|"snapshot"|"spot-fleet-request"|"spot-instances-request"|"subnet"|"subnet-cidr-reservation"|"traffic-mirror-filter"|"traffic-mirror-session"|"traffic-mirror-target"|"transit-gateway"|"transit-gateway-attachment"|"transit-gateway-connect-peer"|"transit-gateway-multicast-domain"|"transit-gateway-policy-table"|"transit-gateway-route-table"|"transit-gateway-route-table-announcement"|"volume"|"vpc"|"vpc-endpoint"|"vpc-endpoint-connection"|"vpc-endpoint-service"|"vpc-endpoint-service-permission"|"vpc-peering-connection"|"vpn-connection"|"vpn-gateway"|"vpc-flow-log"|"capacity-reservation-fleet"|"traffic-mirror-filter-rule"|"vpc-endpoint-connection-device-type"|"verified-access-instance"|"verified-access-group"|"verified-access-endpoint"|"verified-access-policy"|"verified-access-trust-provider"|"vpn-connection-device-type"|"vpc-block-public-access-exclusion"|"route-server"|"route-server-endpoint"|"route-server-peer"|"ipam-resource-discovery"|"ipam-resource-discovery-association"|"instance-connect-endpoint"|"verified-access-endpoint-target"|"ipam-external-resource-verification-token"|"mac-modification-task",
"Tags": [
{
"Key": "string",
"Value": "string"
}
...
]
}
...
]
--client-token (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-auto-prompt (boolean)
Автоматически запросить параметры входных данных CLI.
--no-cli-auto-prompt (boolean)
Отключить автоматический запрос параметров входных данных CLI.
Примеры
Примечание
Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.
Если не указано иное, во всех примерах используются правила цитирования Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной оболочки. См. раздел Использование кавычек со строками в Руководстве пользователя AWS CLI.
Создание открытия ресурсов
В этом примере вы — делегированный администратор IPAM, который хочет создать и поделиться открытием ресурсов с администратором IPAM в другой организации AWS, чтобы администратор другой организации мог управлять и контролировать IP-адреса ресурсов в вашей организации.
Важно
- В этом примере включены как
--region, так и--operating-regions, поскольку, хотя они необязательны, они должны быть настроены определённым образом для успешной интеграции открытия ресурсов с IPAM. *--operating-regionsдолжны соответствовать регионам, где у вас есть ресурсы, которые вы хотите, чтобы IPAM обнаружил. Если есть регионы, где вы не хотите, чтобы IPAM управлял IP-адресами (например, по соображениям соответствия), не включайте их. *--regionдолжен соответствовать домашнему региону IPAM, с которым вы хотите связать его. Вам необходимо создать открытие ресурсов в том же регионе, где создан IPAM. Например, если IPAM, с которым вы связываетесь, был создан в us-east-1, включите--region us-east-1в запрос. - Как
--region, так и--operating-regionsпо умолчанию устанавливаются в регион, в котором вы выполняете команду, если вы их не укажете.
В этом примере рабочие регионы IPAM, с которым мы интегрируемся, включают us-west-1, us-west-2 и ap-south-1. При создании открытия ресурсов мы хотим, чтобы IPAM обнаружил IP-адреса ресурсов в us-west-1 и us-west-2, но не в ap-south-1. Поэтому мы включаем только --operating-regions RegionName='us-west-1' RegionName='us-west-2' в запрос.
Следующий create-ipam-resource-discovery пример создаёт открытие ресурсов IPAM.
aws ec2 create-ipam-resource-discovery \
--description 'Example-resource-discovery' \
--tag-specifications 'ResourceType=ipam-resource-discovery,Tags=[{Key=cost-center,Value=cc123}]' \
--operating-regions RegionName='us-west-1' RegionName='us-west-2' \
--region us-east-1
Вывод:
{
"IpamResourceDiscovery":{
"OwnerId": "149977607591",
"IpamResourceDiscoveryId": "ipam-res-disco-0257046d8aa78b8bc",
"IpamResourceDiscoveryArn": "arn:aws:ec2::149977607591:ipam-resource-discovery/ipam-res-disco-0257046d8aa78b8bc",
"IpamResourceDiscoveryRegion": "us-east-1",
"Description": "'Example-resource-discovery'",
"OperatingRegions":[
{"RegionName": "us-west-1"},
{"RegionName": "us-west-2"},
{"RegionName": "us-east-1"}
],
"IsDefault": false,
"State": "create-in-progress",
"Tags": [
{
"Key": "cost-center",
"Value": "cc123"
}
]
}
После создания открытия ресурсов вы можете поделиться им с другим администратором IPAM, что можно сделать с помощью create-resource-share. Дополнительную информацию см. в разделе Интеграция IPAM с учётными записями за пределами вашей организации в Руководстве пользователя Amazon VPC IPAM.
Вывод
IpamResourceDiscovery -> (структура)
Открытие ресурсов IPAM.
OwnerId -> (строка)
IpamResourceDiscoveryId -> (строка)
IpamResourceDiscoveryArn -> (строка)
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 User Guide.
RegionName -> (строка)
IsDefault -> (булево)
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 -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.