Spec-Zone.ru › AWS CLI v2

[ aws . ec2 ]

create-ipam

Описание

Создать IPAM. Amazon VPC IP Address Manager (IPAM) — это функция VPC, которую можно использовать для автоматизации рабочих процессов управления IP-адресами, включая назначение, отслеживание, устранение неполадок и аудит IP-адресов в регионах Amazon Web Services и учетных записях по всей вашей организации Amazon Web Services.

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

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

Синтаксис

  create-ipam
[--dry-run | --no-dry-run]
[--description <value>]
[--operating-regions <value>]
[--tag-specifications <value>]
[--client-token <value>]
[--tier <value>]
[--enable-private-gua | --no-enable-private-gua]
[--metered-account <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)

Описание IPAM.

--operating-regions (list)

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

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

(структура)

Добавление операционного региона в 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)

Сочетание ключ/значение тега, назначенного ресурсу. Используйте ключ тега в имени фильтра и значение тега в качестве значения фильтра. Например, чтобы найти все ресурсы, которые имеют тег с ключом Owner и значением TeamA , укажите tag:Owner для имени фильтра и TeamA для значения фильтра.

(структура)

Теги, которые нужно применить к ресурсу при его создании. При указании тега необходимо указать тип ресурса, иначе запрос завершится ошибкой.

Примечание

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)

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

--tier (string)

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

Возможные значения:

  • free
  • advanced

--enable-private-gua | --no-enable-private-gua (boolean)

Включите этот параметр, чтобы использовать собственные диапазоны GUA в качестве частных IPv6-адресов. По умолчанию этот параметр отключён.

--metered-account (string)

Учётная запись с измерениями — это учётная запись Amazon Web Services, которая оплачивает активные IP-адреса, управляемые в IPAM. Дополнительную информацию см. в разделе Включение распределения затрат в руководстве пользователя Amazon VPC IPAM .

Возможные значения:

  • ipam-owner (по умолчанию): учётная запись Amazon Web Services, владеющая IPAM, оплачивает все активные IP-адреса, управляемые в IPAM.
  • resource-owner : учётная запись Amazon Web Services, владеющая IP-адресом, оплачивает активный IP-адрес.

Возможные значения:

  • ipam-owner
  • resource-owner

--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 версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, 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

Следующий create-ipam пример создаёт IPAM.

(Linux):

aws ec2 create-ipam \
    --description "Example description" \
    --operating-regions "RegionName=us-east-2" "RegionName=us-west-1" \
    --tag-specifications 'ResourceType=ipam,Tags=[{Key=Name,Value=ExampleIPAM}]'

(Windows):

aws ec2 create-ipam ^
    --description "Example description" ^
    --operating-regions "RegionName=us-east-2" "RegionName=us-west-1" ^
    --tag-specifications ResourceType=ipam,Tags=[{Key=Name,Value=ExampleIPAM}]

Вывод:

{
    "Ipam": {
        "OwnerId": "123456789012",
        "IpamId": "ipam-036486dfa6af58ee0",
        "IpamArn": "arn:aws:ec2::123456789012:ipam/ipam-036486dfa6af58ee0",
        "IpamRegion": "us-east-1",
        "PublicDefaultScopeId": "ipam-scope-071b8042b0195c183",
        "PrivateDefaultScopeId": "ipam-scope-0807405dece705a30",
        "ScopeCount": 2,
        "OperatingRegions": [
            {
                "RegionName": "us-east-2"
            },
            {
                "RegionName": "us-west-1"
            },
            {
                "RegionName": "us-east-1"
            }
        ],
        "State": "create-in-progress",
        "Tags": [
            {
                "Key": "Name",
                "Value": "ExampleIPAM"
            }
        ]
    }
}

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

Вывод

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

Информация об созданном IPAM.

OwnerId -> (строка)

Идентификатор учетной записи Amazon Web Services владельца IPAM.

IpamId -> (строка)

Идентификатор IPAM.

IpamArn -> (строка)

Amazon Resource Name (ARN) IPAM.

IpamRegion -> (строка)

Регион Amazon Web Services IPAM.

PublicDefaultScopeId -> (строка)

Идентификатор по умолчанию публичного раздела IPAM.

PrivateDefaultScopeId -> (строка)

Идентификатор по умолчанию закрытого раздела IPAM.

ScopeCount -> (целое число)

Количество разделов в IPAM. Квота на разделы составляет 5. Дополнительную информацию о квотах см. в разделе «Квоты в IPAM» в руководстве пользователя Amazon VPC IPAM.

Description -> (строка)

Описание IPAM.

OperatingRegions -> (список)

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

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

(структура)

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

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

RegionName -> (строка)

Название операционного региона.

State -> (строка)

Состояние IPAM.

Tags -> (список)

Сочетание ключ/значение тега, назначенного ресурсу. Используйте ключ тега в имени фильтра и значение тега в качестве значения фильтра. Например, чтобы найти все ресурсы, которые имеют тег с ключом Owner и значением TeamA , укажите tag:Owner для имени фильтра и TeamA для значения фильтра.

(структура)

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

Key -> (строка)

Ключ тега.

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

Value -> (строка)

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

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

DefaultResourceDiscoveryId -> (строка)

Идентификатор обнаружения ресурсов по умолчанию IPAM.

DefaultResourceDiscoveryAssociationId -> (строка)

Идентификатор ассоциации обнаружения ресурсов по умолчанию IPAM.

ResourceDiscoveryAssociationCount -> (целое число)

Количество ассоциаций обнаружения ресурсов IPAM.

StateMessage -> (строка)

Сообщение о состоянии.

Tier -> (строка)

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

EnablePrivateGua -> (булево)

Включите этот параметр, чтобы использовать собственные диапазоны GUA в качестве частных IPv6 адресов. Этот параметр по умолчанию отключен.

MeteredAccount -> (строка)

Учетная запись с метрикой — это учетная запись Amazon Web Services, которая взимает плату за активные IP-адреса, управляемые в IPAM. Дополнительную информацию см. в разделе «Включение распределения расходов» в руководстве пользователя Amazon VPC IPAM.

Возможные значения:

  • ipam-owner (по умолчанию): Учетная запись Amazon Web Services, которая владеет IPAM, оплачивает все активные IP-адреса, управляемые в IPAM.
  • resource-owner : Учетная запись Amazon Web Services, которая владеет IP-адресом, оплачивает активный IP-адрес.

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

Spec-Zone.ru

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