Spec-Zone.ru › AWS CLI v2

[ aws . ec2 ]

create-image

Описание

Создаёт AMI на основе Amazon EBS, из экземпляра Amazon EBS, который работает или остановлен.

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

Для получения дополнительной информации см. Create an Amazon EBS-backed Linux AMI в Руководстве пользователя Amazon Elastic Compute Cloud.

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

Синтаксис

  create-image
[--tag-specifications <value>]
[--dry-run | --no-dry-run]
--instance-id <value>
--name <value>
[--description <value>]
[--no-reboot | --reboot]
[--block-device-mappings <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]

Параметры

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

Теги, которые необходимо применить к AMI и снимкам при создании. Вы можете применить теги к AMI, снимкам или к обоим.

  • Чтобы применить теги к AMI, значение для ResourceType должно быть image.
  • Чтобы применить теги к снимкам, созданным для корневого тома и других томов Amazon EBS, подключённых к экземпляру, значение для ResourceType должно быть snapshot. Один и тот же тег применяется ко всем созданным снимкам.

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

Чтобы применить теги к AMI или снимку после создания, см. CreateTags.

(структура)

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

Примечание

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

ResourceType -> (строка)

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

Tags -> (список)

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

(структура)

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

Key -> (строка)

Ключ тега.

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

Value -> (строка)

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

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

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

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 (булево)

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

--instance-id (строка)

Идентификатор экземпляра.

--name (строка)

Имя для нового образа.

Ограничения: 3-128 буквенно-цифровых символов, скобки (()), квадратные скобки ([]), пробелы ( ), точки (.), слэши (/), дефисы (-), одинарные кавычки (‘), знаки @ или нижние подчеркивания.

--description (строка)

Описание нового образа.

--no-reboot | --reboot (булево)

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

  • true - экземпляр не перезагружается перед созданием образа. Это создаёт снимки, соответствующие состоянию ошибки, которые включают только данные, которые были записаны в тома в момент создания снимков. Буферизованные данные и данные в памяти, которые ещё не были записаны в тома, не включаются в снимки.
  • false - экземпляр перезагружается перед созданием образа. Это гарантирует, что все буферизованные данные и данные в памяти будут записаны в тома перед созданием снимков.

По умолчанию: false

--block-device-mappings (список)

Сопоставления блочных устройств.

При использовании действия CreateImage:

  • Вы не можете изменить размер тома, используя параметр VolumeSize. Если вам нужен тома с другим размером, сначала необходимо изменить размер тома исходной инстанции.
  • Вы не можете изменить состояние шифрования существующих томов или снимков. Чтобы создать AMI с томами или снимками, которые имеют другое состояние шифрования (например, когда исходный том и снимки не зашифрованы, а вы хотите создать AMI с зашифрованными томами или снимками), используйте действие CopyImage.
  • Единственный параметр, который можно изменить для существующих сопоставлений или снимков, это DeleteOnTermination .

(структура)

Описание сопоставления блочных устройств, определяющего EBS-тома и тома хранилища экземпляра, которые будут подключены к экземпляру при запуске.

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

Параметры, используемые для автоматической настройки EBS-томов при запуске экземпляра.

DeleteOnTermination -> (boolean)

Указывает, будет ли EBS-том удален при завершении работы экземпляра. Дополнительную информацию см. в разделе "Сохранение томов Amazon EBS при завершении работы экземпляра" в руководстве пользователя Amazon EC2.

Iops -> (integer)

Количество операций ввода-вывода в секунду (IOPS). Для gp3 , io1 и io2 томов это количество IOPS, выделенных для тома. Для gp2 томов это базовая производительность тома и скорость, с которой том накапливает кредиты I/O для повышения производительности.

Ниже приведены поддерживаемые значения для каждого типа тома:

  • gp3 : 3 000—16 000 IOPS
  • io1 : 100—64 000 IOPS
  • io2 : 100—256 000 IOPS

Для io2 томов вы можете достичь до 256 000 IOPS на экземплярах, построенных на платформе Nitro System. На других экземплярах вы можете достичь производительности до 32 000 IOPS.

Этот параметр обязателен для io1 и io2 томов. По умолчанию для gp3 томов используется 3 000 IOPS.

SnapshotId -> (string)

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

VolumeSize -> (integer)

Размер тома в GiB. Вы должны указать либо идентификатор снимка, либо размер тома. Если вы указываете снимок, по умолчанию используется размер снимка. Вы можете указать размер тома, равный или больший, чем размер снимка.

Ниже приведены поддерживаемые размеры для каждого типа тома:

  • gp2 и gp3 : 1—16 384 GiB
  • io1 : 4—16 384 GiB
  • io2 : 4—65 536 GiB
  • st1 и sc1 : 125—16 384 GiB
  • standard : 1—1024 GiB

VolumeType -> (string)

Тип тома. Дополнительную информацию см. в разделе "Типы томов Amazon EBS" в руководстве пользователя Amazon EBS.

KmsKeyId -> (string)

Идентификатор (идентификатор ключа, псевдоним ключа, ARN ключа или ARN псевдонима) управляемого клиентом ключа KMS, который нужно использовать для шифрования EBS.

Этот параметр поддерживается только для BlockDeviceMapping объектов, вызываемых из RunInstances, RequestSpotFleet и RequestSpotInstances.

Throughput -> (integer)

Пропускная способность, поддерживаемая томом, в МБ/с.

Этот параметр действителен только для gp3 томов.

Диапазон допустимых значений: Минимальное значение 125. Максимальное значение 1000.

OutpostArn -> (string)

ARN Outpost, на котором хранится снимок.

Этот параметр не поддерживается при использовании CreateImage.

Encrypted -> (boolean)

Указывает, было ли состояние шифрования EBS-тома изменено при восстановлении из резервного снимка. Действие установки состояния шифрования в true зависит от происхождения тома (новый или из снимка), начального состояния шифрования, владения и включения шифрования по умолчанию. Дополнительную информацию см. в разделе "Шифрование Amazon EBS" в руководстве пользователя Amazon EBS.

В любом случае вы не можете отключить шифрование для зашифрованного тома.

Зашифрованные тома могут быть подключены только к экземплярам, которые поддерживают шифрование Amazon EBS. Дополнительную информацию см. в разделе Поддерживаемые типы экземпляров.

Этот параметр не возвращается действием DescribeImageAttribute.

Для CreateImage и RegisterImage возможность включения этого параметра и допустимые значения зависят от типа сопоставления блочных устройств, которое вы создаете.

  • Если вы создаете сопоставление блочных устройств для **нового (пустого) тома**, вы можете включить этот параметр и указать true для зашифрованного тома или false для незашифрованного тома. Если вы опустите этот параметр, он по умолчанию будет false (незашифрованный).
  • Если вы создаете сопоставление блочных устройств из **существующего зашифрованного или незашифрованного снимка**, вы должны опустить этот параметр. Если вы включите этот параметр, запрос завершится с ошибкой, независимо от указанного значения.
  • Если вы создаете сопоставление блочных устройств из **существующего незашифрованного тома**, вы можете включить этот параметр, но должны указать false. Если вы укажете true, запрос завершится с ошибкой. В этом случае рекомендуется опустить параметр.
  • Если вы создаете сопоставление блочных устройств из **существующего зашифрованного тома**, вы можете включить этот параметр и указать true или false. Однако, если вы укажете false, параметр игнорируется, и сопоставление блочных устройств всегда будет зашифровано. В этом случае рекомендуется опустить параметр.

VolumeInitializationRate -> (integer)

Указывает скорость инициализации тома Amazon EBS в МБ/с, с которой блоки снимка загружаются из Amazon S3 на том. Это также известно как инициализация тома. Указание скорости инициализации тома обеспечивает, что том будет инициализирован с прогнозируемой и стабильной скоростью после создания.

Этот параметр поддерживается только для томов, созданных из снимков. Опустите этот параметр, если:

  • Вы хотите создать том, используя быстрое восстановление снимка. Вы должны указать снимок, включенный в быстрое восстановление снимка. В этом случае том полностью инициализируется при создании.

Примечание

Если вы укажете снимок, включенный в быстрое восстановление снимка, и скорость инициализации тома, том будет инициализирован со заданной скоростью вместо быстрого восстановления снимка.
  • Вы хотите создать том, который инициализируется по умолчанию.

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

Этот параметр не поддерживается при использовании CreateImage.

Допустимый диапазон: 100—300 МБ/с

NoDevice -> (string)

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

DeviceName -> (string)

Имя устройства (например, /dev/sdh или xvdh).

VirtualName -> (string)

Виртуальное имя устройства (ephemeral N). Тома хранилища экземпляров нумеруются, начиная с 0. Тип экземпляра с 2 доступными томами хранилища экземпляров может указать сопоставления для ephemeral0 и ephemeral1. Количество доступных томов хранилища экземпляров зависит от типа экземпляра. После подключения к экземпляру вы должны смонтировать том.

Тома хранилища экземпляров NVMe автоматически перечисляются и получают имя устройства. Их включение в сопоставление блочных устройств не оказывает никакого эффекта.

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

Сокращенная синтаксическая запись:

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

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

Файл сертификатов 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.

Пример 1: Создание AMI из экземпляра с поддержкой Amazon EBS

Следующий create-image пример создаёт AMI из указанного экземпляра.

aws ec2 create-image \
    --instance-id i-1234567890abcdef0 \
    --name "My server" \
    --description "An AMI for my server"

Вывод:

{
    "ImageId": "ami-abcdef01234567890"
}

Дополнительную информацию о задании отображения карты блочных устройств для вашей AMI см. в разделе «Указание отображения карты блочных устройств для AMI» в Руководстве пользователя Amazon EC2.

Пример 2: Создание AMI из экземпляра с поддержкой Amazon EBS без перезагрузки

Следующий create-image пример создаёт AMI и устанавливает параметр –no-reboot, чтобы экземпляр не перезагружался перед созданием образа.

aws ec2 create-image \
    --instance-id i-1234567890abcdef0 \
    --name "My server" \
    --no-reboot

Вывод:

{
    "ImageId": "ami-abcdef01234567890"
}

Дополнительную информацию о задании отображения карты блочных устройств для вашей AMI см. в разделе «Указание отображения карты блочных устройств для AMI» в Руководстве пользователя Amazon EC2.

Пример 3: Разметка AMI и снимков при создании

Следующий create-image пример создаёт AMI и размечает AMI и снимки с той же меткой cost-center=cc123

aws ec2 create-image \
    --instance-id i-1234567890abcdef0 \
    --name "My server" \
    --tag-specifications "ResourceType=image,Tags=[{Key=cost-center,Value=cc123}]" "ResourceType=snapshot,Tags=[{Key=cost-center,Value=cc123}]"

Вывод:

{
    "ImageId": "ami-abcdef01234567890"
}

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

Вывод

ImageId -> (строка)

Идентификатор нового AMI.

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

Spec-Zone.ru

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