Spec-Zone.ru › AWS CLI v2

[ aws . ec2 ]

Задача экспорта экземпляра

Описание

Экспортирует запущенный или остановленный экземпляр в ведро Amazon S3.

Сведения о предварительных требованиях к вашему ведру Amazon S3, поддерживаемых операционных системах, форматах изображений и известных ограничениях для типов экземпляров, которые вы можете экспортировать, см. в разделе Экспорт экземпляра в виде виртуальной машины с помощью импорта/экспорта виртуальных машин в руководстве пользователя по импорту/экспорту виртуальных машин.

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

Синтаксис

  create-instance-export-task
[--tag-specifications <value>]
[--description <value>]
--instance-id <value>
--target-environment <value>
--export-to-s3-task <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 (список)

Теги, которые необходимо применить к задаче экспорта экземпляра при создании.

(структура)

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

Примечание

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

ResourceType -> (строка)

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

Tags -> (список)

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

(структура)

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

Key -> (строка)

Ключ тега.

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

Value -> (строка)

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

Ограничения: значения тегов чувствительны к регистру и принимают максимум 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"
      }
      ...
    ]
  }
  ...
]

--description (строка)

Описание задачи преобразования или экспортируемого ресурса. Максимальная длина — 255 символов.

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

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

--target-environment (строка)

Целевая среда виртуализации.

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

  • citrix
  • vmware
  • microsoft

--export-to-s3-task (структура)

Формат и местоположение для задачи экспорта экземпляра.

DiskImageFormat -> (строка)

Формат экспортируемого изображения.

ContainerFormat -> (строка)

Формат контейнера, используемый для объединения образов дисков с метаданными (например, OVF). Если отсутствует, экспортируется только образ диска.

S3Bucket -> (строка)

Ведро Amazon S3 для целевого изображения. Ведро назначения должно существовать и иметь список управления доступом (ACL), который указывает канонический идентификатор учетной записи области для Grantee. Дополнительные сведения об ACL вашего ведра S3 см. в разделе Предварительные требования в руководстве пользователя по импорту/экспорту виртуальных машин.

S3Prefix -> (строка)

Изображение записывается в один объект в ведре Amazon S3 по ключу S3 s3prefix + exportTaskId + ‘.’ + diskImageFormat.

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

DiskImageFormat=string,ContainerFormat=string,S3Bucket=string,S3Prefix=string

Синтаксис JSON:

{
  "DiskImageFormat": "VMDK"|"RAW"|"VHD",
  "ContainerFormat": "ova",
  "S3Bucket": "string",
  "S3Prefix": "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 (булево)

Включить отладку.

--endpoint-url (строка)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (булево)

По умолчанию AWS CLI использует SSL при общении с услугами AWS. Для каждого SSL-соединения AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение по умолчанию, связанное с проверкой сертификатов SSL.

--no-paginate (булево)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

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

--region (строка)

Используемая область. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • вкл
  • выкл
  • авто

--no-sign-request (булево)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.

--ca-bundle (строка)

Файл-сборка сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и не будет ограничено по времени. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и не будет ограничено по времени. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

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

Отключить пейджер CLI для вывода.

--cli-auto-prompt (булево)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (булево)

Отключить автоматический запрос параметров ввода CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительные сведения см. в руководстве пользователя AWS CLI в разделе «Начало работы».

Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки терминала. Дополнительные сведения см. в разделе «Использование кавычек со строками» в руководстве пользователя AWS CLI.

Для экспорта экземпляра

В этом примере команды создается задача экспорта экземпляра i-1234567890abcdef0 в ведро Amazon S3 myexportbucket.

Команда:

aws ec2 create-instance-export-task --description "RHEL5 instance" --instance-id i-1234567890abcdef0 --target-environment vmware --export-to-s3-task DiskImageFormat=vmdk,ContainerFormat=ova,S3Bucket=myexportbucket,S3Prefix=RHEL5

Вывод:

{
    "ExportTask": {
        "State": "active",
        "InstanceExportDetails": {
            "InstanceId": "i-1234567890abcdef0",
            "TargetEnvironment": "vmware"
        },
        "ExportToS3Task": {
            "S3Bucket": "myexportbucket",
            "S3Key": "RHEL5export-i-fh8sjjsq.ova",
            "DiskImageFormat": "vmdk",
            "ContainerFormat": "ova"
        },
        "Description": "RHEL5 instance",
        "ExportTaskId": "export-i-fh8sjjsq"
    }
}

Вывод

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

Сведения о задаче экспорта экземпляра.

Description -> (строка)

Описание экспортируемого ресурса.

ExportTaskId -> (строка)

Идентификатор задачи экспорта.

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

Сведения о задаче экспорта.

ContainerFormat -> (строка)

Формат контейнера, используемый для объединения образов дисков с метаданными (например, OVF). Если отсутствует, экспортируется только образ диска.

DiskImageFormat -> (строка)

Формат экспортируемого изображения.

S3Bucket -> (строка)

Ведро Amazon S3 для целевого изображения. Ведро назначения должно существовать и иметь список управления доступом (ACL), который указывает канонический идентификатор учетной записи области для Grantee. Дополнительные сведения об ACL вашего ведра S3 см. в разделе Предварительные требования в руководстве пользователя по импорту/экспорту виртуальных машин.

S3Key -> (строка)

Ключ шифрования для вашего ведра S3.

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

Сведения об экземпляре, который нужно экспортировать.

InstanceId -> (строка)

Идентификатор экспортируемого ресурса.

TargetEnvironment -> (строка)

Целевая среда виртуализации.

State -> (строка)

Состояние задачи экспорта.

StatusMessage -> (строка)

Сообщение состояния, связанное с задачей экспорта.

Tags -> (список)

Теги задачи экспорта.

(структура)

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

Key -> (строка)

Ключ тега.

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

Value -> (строка)

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

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

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

Spec-Zone.ru

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