создать-пул-ipam

Описание

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

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

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

Синтаксис

  create-ipam-pool
[--dry-run | --no-dry-run]
--ipam-scope-id <value>
[--locale <value>]
[--source-ipam-pool-id <value>]
[--description <value>]
--address-family <value>
[--auto-import| --no-auto-import]
[--publicly-advertisable | --no-publicly-advertisable]
[--allocation-min-netmask-length <value>]
[--allocation-max-netmask-length <value>]
[--allocation-default-netmask-length <value>]
[--allocation-resource-tags <value>]
[--tag-specifications <value>]
[--client-token <value>]
[--aws-service <value>]
[--public-ip-source <value>]
[--source-resource <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-scope-id (string)

Идентификатор области, в которой вы хотите создать пул IPAM.

--locale (string)

Локаль для пула должна быть одной из следующих:

Регион Amazon Web Services, в котором вы хотите, чтобы этот пул IPAM был доступен для выделения.
Группа сетевых границ для локальной зоны Amazon Web Services, в которой вы хотите, чтобы этот пул IPAM был доступен для выделения (поддерживаемые локальные зоны). Этот параметр доступен только для пулов IPAM IPv4 в общедоступной области.

Возможные значения: Любой регион Amazon Web Services или поддерживаемая локальная зона Amazon Web Services. По умолчанию — none, что означает любую локаль.

--source-ipam-pool-id (string)

Идентификатор исходного пула IPAM. Используйте этот параметр для создания пула внутри существующего пула. Обратите внимание, что CIDR, который вы предоставляете для пула внутри исходного пула, должен быть доступен в диапазоне CIDR исходного пула.

--description (string)

Описание пула IPAM.

--address-family (string)

Протокол IP, назначенный этому пулу IPAM. Вы должны выбрать либо IPv4, либо IPv6-протокол для пула.

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

ipv4
ipv6

--auto-import | --no-auto-import (boolean)

При выборе IPAM будет непрерывно искать ресурсы в диапазоне CIDR этого пула и автоматически импортировать их в качестве выделений в ваш IPAM. CIDR, которые будут выделены для этих ресурсов, не должны быть уже выделены другим ресурсам, чтобы импорт был успешным. IPAM будет импортировать CIDR независимо от его соответствия правилам выделения пула, поэтому ресурс может быть импортирован и впоследствии помечен как несоответствующий. Если IPAM обнаружит несколько перекрывающихся CIDR, IPAM импортирует только самый большой CIDR. Если IPAM обнаружит несколько CIDR с совпадающими CIDR, IPAM импортирует только один из них случайным образом.

Для работы этой функции необходимо задать локаль для пула.

--publicly-advertisable | --no-publicly-advertisable (boolean)

Определяет, является ли пул общедоступным. Запрос может содержать только PubliclyAdvertisable, если AddressFamily равен ipv6, и PublicIpSource равен byoip.

--allocation-min-netmask-length (integer)

Минимальная длина маски сети, необходимая для соответствия CIDR-выделений в этом пуле IPAM. Минимальная длина маски сети должна быть меньше максимальной длины маски сети. Возможные длины масок сети для IPv4-адресов — от 0 до 32. Возможные длины масок сети для IPv6-адресов — от 0 до 128.

--allocation-max-netmask-length (integer)

Максимальная длина маски сети, возможная для соответствия CIDR-выделений в этом пуле IPAM. Максимальная длина маски сети должна быть больше минимальной длины маски сети. Возможные длины масок сети для IPv4-адресов — от 0 до 32. Возможные длины масок сети для IPv6-адресов — от 0 до 128.

--allocation-default-netmask-length (integer)

Длина маски сети по умолчанию для выделений, добавленных в этот пул. Если, например, CIDR, назначенный этому пулу, равен 10.0.0.0/8, и вы введете здесь 16, новые выделения будут по умолчанию 10.0.0.0/16.

--allocation-resource-tags (list)

Теги, необходимые для ресурсов, использующих CIDR из этого пула IPAM. Ресурсы, у которых нет этих тегов, не смогут выделять место из пула. Если теги ресурсов изменены после выделения места или требования к тегам выделения изменены в пуле, ресурс может быть помечен как несоответствующий.

(структура)

Тег ресурса IPAM.

Ключ -> (строка)

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

Значение -> (строка)

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

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

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--tag-specifications (list)

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

(структура)

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

Примечание

Список Valid Values содержит все типы ресурсов, которые можно пометить тегами. Однако используемое действие может не поддерживать тегирование всех этих типов ресурсов. Если вы попытаетесь пометить тегами тип ресурса, который не поддерживается для используемого действия, вы получите ошибку.

Тип ресурса -> (строка)

Тип ресурса, который нужно пометить тегом при создании.

Теги -> (список)

Теги, которые нужно применить к ресурсу.

(структура)

Описывает тег.

Ключ -> (строка)

Ключ тега.

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

Значение -> (строка)

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

Ограничения: Значения тегов регистрозависимы и принимают максимум 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 (строка)

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

--aws-service (строка)

Ограничивает, какой сервис в Amazon Web Services может использовать пул. Например, «ec2» позволяет пользователям использовать пространство для Elastic IP-адресов и VPC.

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

ec2

--public-ip-source (строка)

Источник IP-адреса для пулов в общедоступной области. Используется только для выделения IP-адресов CIDR для пулов в общедоступной области. По умолчанию — byoip. Дополнительную информацию см. в разделе Создание IPv6-пулов в руководстве пользователя Amazon VPC IPAM. По умолчанию вы можете добавить только один предоставленный Amazon IPv6-блок CIDR в пул IPv6 верхнего уровня, если PublicIpSource равен amazon. Информацию об увеличении лимита см. в разделе Квоты для вашего IPAM в руководстве пользователя Amazon VPC IPAM.

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

amazon
byoip

--source-resource (структура)

Ресурс, используемый для выделения CIDR в пул планирования ресурсов.

Идентификатор ресурса -> (строка)

Идентификатор исходного ресурса.

Тип ресурса -> (строка)

Тип исходного ресурса.

Регион ресурса -> (строка)

Регион исходного ресурса.

Владелец ресурса -> (строка)

Владелец исходного ресурса.

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

ResourceId=string,ResourceType=string,ResourceRegion=string,ResourceOwner=string

Синтаксис JSON:

{
  "ResourceId": "string",
  "ResourceType": "vpc",
  "ResourceRegion": "string",
  "ResourceOwner": "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 (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)

Файл с корневым сертификатом для проверки 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

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

(Linux):

aws ec2 create-ipam-pool \
    --ipam-scope-id ipam-scope-02fc38cd4c48e7d38 \
    --address-family ipv4 \
    --auto-import \
--allocation-min-netmask-length 16 \
    --allocation-max-netmask-length 26 \
    --allocation-default-netmask-length 24 \
    --allocation-resource-tags "Key=Environment,Value=Preprod" \
    --tag-specifications 'ResourceType=ipam-pool,Tags=[{Key=Name,Value="Preprod pool"}]'

(Windows):

aws ec2 create-ipam-pool ^
    --ipam-scope-id ipam-scope-02fc38cd4c48e7d38 ^
    --address-family ipv4 ^
    --auto-import^
    --allocation-min-netmask-length 16 ^
    --allocation-max-netmask-length 26 ^
    --allocation-default-netmask-length 24 ^
    --allocation-resource-tags "Key=Environment,Value=Preprod" ^
    --tag-specifications ResourceType=ipam-pool,Tags=[{Key=Name,Value="Preprod pool"}]

Вывод:

{
    "IpamPool": {
        "OwnerId": "123456789012",
        "IpamPoolId": "ipam-pool-0533048da7d823723",
        "IpamPoolArn": "arn:aws:ec2::123456789012:ipam-pool/ipam-pool-0533048da7d823723",
        "IpamScopeArn": "arn:aws:ec2::123456789012:ipam-scope/ipam-scope-02fc38cd4c48e7d38",
        "IpamScopeType": "private",
        "IpamArn": "arn:aws:ec2::123456789012:ipam/ipam-08440e7a3acde3908",
        "IpamRegion": "us-east-1",
        "Locale": "None",
        "PoolDepth": 1,
        "State": "create-in-progress",
        "AutoImport": true,
        "AddressFamily": "ipv4",
        "AllocationMinNetmaskLength": 16,
        "AllocationMaxNetmaskLength": 26,
        "AllocationDefaultNetmaskLength": 24,
        "AllocationResourceTags": [
            {
                "Key": "Environment",
                "Value": "Preprod"
            }
        ],
        "Tags": [
            {
                "Key": "Name",
                "Value": "Preprod pool"
            }
        ]
    }
}

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

Вывод

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

Информация о созданном пуле IPAM.

OwnerId -> (строка)

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

IpamPoolId -> (строка)

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

SourceIpamPoolId -> (строка)

Идентификатор исходного пула IPAM. Вы можете использовать этот параметр для создания пула IPAM в рамках существующего исходного пула.

IpamPoolArn -> (строка)

Amazon Resource Name (ARN) пула IPAM.

IpamScopeArn -> (строка)

ARN области пула IPAM.

IpamScopeType -> (строка)

В IPAM область — это контейнер самого высокого уровня в IPAM. IPAM содержит две области по умолчанию. Каждая область представляет адресное пространство одной сети. Область private предназначена для всего частного адресного пространства. Область public предназначена для всего публичного адресного пространства. Области позволяют повторно использовать IP-адреса в нескольких несвязанных сетях без перекрытия или конфликтов IP-адресов.

IpamArn -> (строка)

ARN IPAM.

IpamRegion -> (строка)

Регион Amazon Web Services пула IPAM.

Locale -> (строка)

Локаль пула IPAM.

Локаль пула должна быть одной из следующих:

Регион Amazon Web Services, в котором вы хотите, чтобы этот пул IPAM был доступен для распределения.
Группа сетевых границ для зоны Amazon Web Services Local Zone, в которой вы хотите, чтобы этот пул IPAM был доступен для распределения (поддерживаемые локальные зоны). Этот параметр доступен только для пулов IPv4 IPAM в общедоступной области.

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

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

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

State -> (строка)

Состояние пула IPAM.

StateMessage -> (строка)

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

Description -> (строка)

Описание пула IPAM.

AutoImport -> (boolean)

При включении IPAM постоянно ищет ресурсы в диапазоне CIDR данного пула и автоматически импортирует их как распределения в ваш IPAM. CIDR, которые будут распределяться для этих ресурсов, не должны быть уже распределены другим ресурсам, чтобы импорт был успешным. IPAM будет импортировать CIDR независимо от его соответствия правилам распределения пула, поэтому ресурс может быть импортирован и впоследствии помечен как несоответствующий. Если IPAM обнаруживает несколько перекрывающихся CIDR, IPAM импортирует только наибольший CIDR. Если IPAM обнаруживает несколько CIDR с совпадающими CIDR, IPAM случайным образом импортирует только один из них.

Для работы этой функции должна быть установлена локаль пула.

PubliclyAdvertisable -> (boolean)

Определяет, доступен ли пул для публичной рекламы. Этот параметр недоступен для пулов с AddressFamily, установленным на ipv4.

AddressFamily -> (строка)

Семейство адресов пула.

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

Минимальная длина маски сети, необходимая для соответствия распределения CIDR в этом пуле IPAM. Минимальная длина маски сети должна быть меньше максимальной длины маски сети. Возможные длины масок сети для IPv4-адресов составляют 0–32. Возможные длины масок сети для IPv6-адресов составляют 0–128.

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

Максимальная длина маски сети, возможная для соответствия распределения CIDR в этом пуле IPAM. Максимальная длина маски сети должна быть больше минимальной длины маски сети. Возможные длины масок сети для IPv4-адресов составляют 0–32. Возможные длины масок сети для IPv6-адресов составляют 0–128.

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

Стандартная длина маски сети для распределений, добавленных в этот пул. Если, например, CIDR, назначенный этому пулу, равен 10.0.0.0/8, и вы вводите здесь 16, новые распределения будут по умолчанию 10.0.0.0/16.

AllocationResourceTags -> (список)

Теги, которые необходимы для ресурсов, использующих CIDR из этого пула IPAM. Ресурсы, у которых нет этих тегов, не смогут выделять место из пула. Если теги ресурсов изменены после выделения места или требования к тегам распределения изменены в пуле, ресурс может быть помечен как несоответствующий.

(структура)

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

Key -> (строка)

Value -> (строка)

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

Tags -> (список)

(структура)

Описывает тег.

Key -> (строка)

Ключ тега.

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

Value -> (строка)

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

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

AwsService -> (строка)

Ограничивает сервисы Amazon Web Services, в которых может использоваться пул. Например, «ec2» позволяет пользователям использовать место для адресов Elastic IP и VPC.

PublicIpSource -> (строка)

Источник IP-адреса для пулов в общедоступной области. Используется только для предоставления CIDR-блоков IP-адресов пулам в общедоступной области. Значение по умолчанию — BYOIP. Дополнительную информацию см. в разделе Создание пулов IPv6 в руководстве пользователя Amazon VPC IPAM. По умолчанию вы можете добавить только один предоставленный Amazon CIDR-блок IPv6 в пул IPv6 верхнего уровня. Информацию о повышении лимита по умолчанию см. в разделе Квоты для вашего IPAM в руководстве пользователя Amazon VPC IPAM.

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

Ресурс, используемый для выделения CIDR в пул планирования ресурсов.

ResourceId -> (строка)

Идентификатор исходного ресурса.

ResourceType -> (строка)

Тип исходного ресурса.

ResourceRegion -> (строка)

Регион исходного ресурса.

ResourceOwner -> (строка)

Владелец исходного ресурса.