register-image

Описание

Регистрирует AMI. При создании AMI на основе хранилища экземпляров регистрация AMI является заключительным этапом процесса создания. Дополнительную информацию о создании AMI см. в руководстве пользователя Amazon EC2 в разделах «Создание AMI из моментального снимка» и «Создание AMI на основе хранилища экземпляров».

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

Вы можете использовать RegisterImage для создания Linux AMI Amazon EBS на основе моментального снимка тома корневого устройства. Моментальный снимок указывается с помощью отображения блочных устройств. Вы не можете установить состояние шифрования тома с помощью отображения блочных устройств. Если моментальный снимок зашифрован или по умолчанию включено шифрование, корневой том экземпляра, запущенного из AMI, будет зашифрован.

Дополнительную информацию см. в руководстве пользователя Amazon EC2 в разделах «Создание AMI из моментального снимка» и «Использование шифрования с AMI Amazon EBS».

Если какие-либо моментальные снимки содержат коды продуктов Amazon Web Services Marketplace, они копируются в новый AMI.

В большинстве случаев AMI для Windows, RedHat, SUSE и SQL Server требуют, чтобы на AMI были присутствующие данные о правильной лицензии. Дополнительную информацию см. в руководстве пользователя Amazon EC2 в разделе «Понимание информации о выставлении счетов за AMI». При создании AMI из моментального снимка операция RegisterImage извлекает правильную информацию о выставлении счетов из метаданных моментального снимка, но это требует наличия соответствующих метаданных. Чтобы проверить, была ли применена правильная информация о выставлении счетов, проверьте поле PlatformDetails в новом AMI. Если поле пустое или не соответствует ожидаемому коду операционной системы (например, Windows, RedHat, SUSE или SQL), создание AMI было неуспешным, и вы должны удалить AMI и вместо этого создать AMI из экземпляра с помощью CreateImage. Дополнительную информацию см. в руководстве пользователя Amazon EC2 в разделе «Создание AMI из экземпляра».

Если вы приобрели резервный экземпляр для применения к экземпляру по требованию, который был запущен из AMI с кодом продукта выставления счетов, убедитесь, что резервный экземпляр имеет соответствующий код продукта выставления счетов. Если вы приобрели резервный экземпляр без соответствующего кода продукта выставления счетов, резервный экземпляр не будет применён к экземпляру по требованию. Сведения о получении сведений о платформе и информации о выставлении счетов для AMI см. в руководстве пользователя Amazon EC2 в разделе «Понимание информации о выставлении счетов за AMI».

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

Синтаксис

  register-image
[--image-location <value>]
[--billing-products <value>]
[--boot-mode <value>]
[--tpm-support <value>]
[--uefi-data <value>]
[--imds-support <value>]
[--tag-specifications <value>]
[--dry-run | --no-dry-run]
--name <value>
[--description <value>]
[--architecture <value>]
[--kernel-id <value>]
[--ramdisk-id <value>]
[--root-device-name <value>]
[--block-device-mappings <value>]
[--virtualization-type <value>]
[--sriov-net-support <value>]
[--ena-support | --no-ena-support]
[--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]

Параметры

--image-location (строка)

--billing-products (список)

Синтаксис:

"string" "string" ...

--boot-mode (строка)

--tpm-support (строка)

--uefi-data (строка)

--imds-support (строка)

--tag-specifications (список)

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

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"
      }
      ...
    ]
  }
  ...
]

--dry-run | --no-dry-run (булево)

--name (строка)

--description (строка)

--architecture (строка)

По умолчанию: для AMI на основе Amazon EBS — i386. Для AMI на основе хранилища экземпляров — архитектура, указанная в файле манифеста.

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

• i386
• x86_64
• arm64
• x86_64_mac
• arm64_mac

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

Ebs={DeleteOnTermination=boolean,Iops=integer,SnapshotId=string,VolumeSize=integer,VolumeType=string,KmsKeyId=string,Throughput=integer,OutpostArn=string,Encrypted=boolean,VolumeInitializationRate=integer},NoDevice=string,DeviceName=string,VirtualName=string ...

Синтаксис JSON:

[
  {
    "Ebs": {
      "DeleteOnTermination": true|false,
      "Iops": integer,
      "SnapshotId": "string",
      "VolumeSize": integer,
      "VolumeType": "standard"|"io1"|"io2"|"gp2"|"sc1"|"st1"|"gp3",
      "KmsKeyId": "string",
      "Throughput": integer,
      "OutpostArn": "string",
      "Encrypted": true|false,
      "VolumeInitializationRate": integer
    },
    "NoDevice": "string",
    "DeviceName": "string",
    "VirtualName": "string"
  }
  ...
]

--virtualization-type (string)

--sriov-net-support (string)

--ena-support | --no-ena-support (boolean)

--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.

Примеры

Пример 1: Регистрация AMI с помощью файла манифеста

В следующем register-image примере регистрируется AMI с использованием указанного файла манифеста в Amazon S3.

aws ec2 register-image \
    --name my-image \
    --image-location amzn-s3-demo-bucket/myimage/image.manifest.xml

Вывод:

{
    "ImageId": "ami-1234567890EXAMPLE"
}

Дополнительную информацию см. в разделе «Образы Amazon Machine Images (AMI)» в Руководстве пользователя Amazon EC2.

Пример 2: Регистрация AMI с помощью снимка корневого устройства

В следующем register-image примере регистрируется AMI с использованием указанного снимка тома EBS корневого устройства как устройства /dev/xvda. Карта блочных устройств также включает пустой том EBS объёмом 100 GiB как устройство /dev/xvdf.

aws ec2 register-image \
    --name my-image \
    --root-device-name /dev/xvda \
    --block-device-mappings DeviceName=/dev/xvda,Ebs={SnapshotId=snap-0db2cf683925d191f} DeviceName=/dev/xvdf,Ebs={VolumeSize=100}

Вывод:

{
    "ImageId": "ami-1a2b3c4d5eEXAMPLE"
}

Дополнительную информацию см. в разделе «Образы Amazon Machine Images (AMI)» в Руководстве пользователя Amazon EC2.

Вывод

ImageId -> (строка)