Spec-Zone.ru › AWS CLI v2

[ aws . ec2 ]

копирование-изображения

Описание

Инициализирует операцию копирования AMI. Вы можете скопировать AMI из одной области в другую или из области в Outpost. Вы не можете скопировать AMI из Outpost в область, из одного Outpost в другой или внутри одного Outpost. Чтобы скопировать AMI в другую партию, см. CreateStoreImageTask.

При копировании AMI из одной области в другую целевая область — текущая область.

При копировании AMI из области в Outpost укажите ARN Outpost в качестве места назначения. Резервные снимки, скопированные в Outpost, шифруются по умолчанию с помощью ключа шифрования по умолчанию для области или ключа, который вы укажете. Outpost не поддерживают нешифрованные снимки.

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

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

Синтаксис

  copy-image
[--client-token <value>]
[--description <value>]
[--encrypted | --no-encrypted]
[--kms-key-id <value>]
--name <value>
--source-image-id <value>
--source-region <value>
[--destination-outpost-arn <value>]
[--copy-image-tags | --no-copy-image-tags]
[--tag-specifications <value>]
[--snapshot-copy-completion-duration-minutes <value>]
[--dry-run | --no-dry-run]
[--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]

Параметры

--client-token (строка)

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

--description (строка)

Описание нового AMI в целевой области.

--encrypted | --no-encrypted (логическое значение)

Указывает, следует ли шифровать целевые снимки скопированного образа. Вы можете зашифровать копию нешифрованного снимка, но не можете создать нешифрованную копию зашифрованного снимка. Используется по умолчанию KMS-ключ Amazon EBS, если вы не укажете KMS-ключ (ключ управления ключами) вне по умолчанию, используя KmsKeyId. Дополнительную информацию см. в руководстве пользователя Amazon EC2 «Использование шифрования с AMI с поддержкой EBS».

--kms-key-id (строка)

Идентификатор симметричного ключа управления ключами KMS, который нужно использовать при создании зашифрованных томов. Если этот параметр не указан, используется управляемый Amazon Web Services KMS-ключ для Amazon EBS. Если вы указываете KMS-ключ, вы также должны установить состояние шифрования на true.

Вы можете указать KMS-ключ одним из следующих способов:

  • Идентификатор ключа. Например, 1234abcd-12ab-34cd-56ef-1234567890ab.
  • Псевдоним ключа. Например, alias/ExampleAlias.
  • ARN ключа. Например, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
  • ARN псевдонима. Например, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

Amazon Web Services аутентифицирует KMS-ключ асинхронно. Поэтому, если вы укажете недействительный идентификатор, действие может показаться завершенным, но в конечном итоге завершится с ошибкой.

Указанный KMS-ключ должен существовать в целевой области.

Amazon EBS не поддерживает асимметричные KMS-ключи.

--name (строка)

Имя нового AMI в целевой области.

--source-image-id (строка)

Идентификатор AMI, который нужно скопировать.

--source-region (строка)

Имя области, содержащей AMI для копирования.

--destination-outpost-arn (строка)

Amazon Resource Name (ARN) Outpost, в который нужно скопировать AMI. Указывайте этот параметр только при копировании AMI из области Amazon Web Services в Outpost. AMI должен находиться в области целевого Outpost. Вы не можете скопировать AMI из Outpost в область, из одного Outpost в другой или внутри одного Outpost.

Дополнительную информацию см. в руководстве пользователя Amazon EBS «Копирование AMI из региона Amazon Web Services в Outpost».

--copy-image-tags | --no-copy-image-tags (логическое значение)

Указывает, следует ли включать пользовательские теги AMI при копировании AMI.

Следующие теги не будут скопированы:

  • Системные теги (с префиксом aws: )
  • Для общедоступных и совместных AMI пользовательские теги, добавленные другими учетными записями Amazon Web Services

По умолчанию пользовательские теги AMI не копируются.

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

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

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

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

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

(структура)

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

Примечание

Список 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"
      }
      ...
    ]
  }
  ...
]

--snapshot-copy-completion-duration-minutes (длинное целое число)

Укажите продолжительность завершения в 15-минутных интервалах, чтобы инициировать копирование AMI по таймеру. Указанная продолжительность завершения применяется к каждому снимку, связанному с AMI. Каждый снимок, связанный с AMI, будет завершен в течение указанной продолжительности завершения, а пропускная способность копирования будет автоматически скорректирована для каждого снимка в зависимости от его размера, чтобы достичь целевого времени.

Если вы не укажете значение, операция копирования AMI будет выполнена по возможности.

Дополнительную информацию см. в разделе «Копирование по таймеру».

--dry-run | --no-dry-run (логическое значение)

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

--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
  • текст
  • таблица
  • yaml
  • yaml-потоковый

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

Пример 1: Копирование AMI в другую область

Следующая copy-image команда копирует указанную AMI из области us-west-2 в область us-east-1 и добавляет краткое описание.

aws ec2 copy-image \
    --region us-east-1 \
    --name ami-name \
    --source-region us-west-2 \
    --source-image-id ami-066877671789bd71b \
    --description "This is my copied image."

Вывод:

{
    "ImageId": "ami-0123456789abcdefg"
}

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

Пример 2: Копирование AMI в другую область и шифрование резервного момента снимка

Следующая copy-image команда копирует указанную AMI из области us-west-2 в текущую область и шифрует резервный моментальный снимок с использованием указанного ключа KMS.

aws ec2 copy-image \
    --source-region us-west-2 \
    --name ami-name \
    --source-image-id ami-066877671789bd71b \
    --encrypted \
    --kms-key-id alias/my-kms-key

Вывод:

{
    "ImageId": "ami-0123456789abcdefg"
}

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

Пример 3: Включение пользовательских тегов AMI при копировании AMI

Следующая copy-image команда использует параметр --copy-image-tags для копирования пользовательских тегов AMI при копировании AMI.

aws ec2 copy-image \
    --region us-east-1 \
    --name ami-name \
    --source-region us-west-2 \
    --source-image-id ami-066877671789bd71b \
    --description "This is my copied image."
    --copy-image-tags

Вывод:

{
    "ImageId": "ami-0123456789abcdefg"
}

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

Вывод

ImageId -> (строка)

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

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

Spec-Zone.ru

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