Spec-Zone.ru › AWS CLI v2

[ aws . imagebuilder ]

update-distribution-configuration

Описание

Обновляет конфигурацию распределения. Конфигурации распределения определяют и настраивают выходные данные вашей конвейерной системы.

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

Синтаксис

  update-distribution-configuration
--distribution-configuration-arn <value>
[--description <value>]
--distributions <value>
[--client-token <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]

Параметры

--distribution-configuration-arn (строка)

Amazon Resource Name (ARN) конфигурации распределения, которую вы хотите обновить.

--description (строка)

Описание конфигурации распределения.

--distributions (список)

Распределения конфигурации распределения.

(структура)

Определяет параметры для конкретного региона.

region -> (строка)

Целевой регион.

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

Настройки конкретных AMI; например, права запуска или теги AMI.

name -> (строка)

Имя выходного AMI.

description -> (строка)

Описание конфигурации распределения AMI. Минимальная и максимальная длина в символах.

targetAccountIds -> (список)

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

(строка)

amiTags -> (карта)

Теги, которые необходимо применить к AMI, распределённым в этом регионе.

key -> (строка)

value -> (строка)

kmsKeyId -> (строка)

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

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

Права запуска могут использоваться для настройки того, какие учетные записи Amazon Web Services могут использовать AMI для запуска экземпляров.

userIds -> (список)

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

(строка)

userGroups -> (список)

Имя группы.

(строка)

organizationArns -> (список)

ARN организации Amazon Web Services, с которой вы хотите поделиться своим AMI. Дополнительная информация: Что такое Организации? .

(строка)

organizationalUnitArns -> (список)

ARN организационной единицы (OU) Организаций, с которой вы хотите поделиться своим AMI. Дополнительная информация о ключевых понятиях Организаций: Терминология и концепции Организаций .

(строка)

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

Настройки распределения контейнеров для шифрования, лицензирования и совместного использования в конкретном регионе.

description -> (строка)

Описание конфигурации распределения контейнеров.

containerTags -> (список)

Теги, прикрепленные к конфигурации распределения контейнера.

(строка)

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

Целевой репозиторий для конфигурации распределения контейнеров.

service -> (строка)

Указывает сервис, в котором был зарегистрирован этот образ.

repositoryName -> (строка)

Имя репозитория контейнеров, где хранится выходной образ контейнера. Это имя префикс репозитория. Например, <repository location url>/repository_name .

licenseConfigurationArns -> (список)

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

(строка)

launchTemplateConfigurations -> (список)

Группа настроек launchTemplateConfiguration, которые применяются к распределению изображений для указанных учетных записей.

(структура)

Идентифицирует шаблон запуска Amazon EC2 для использования для конкретной учетной записи.

launchTemplateId -> (строка)

Идентифицирует шаблон запуска Amazon EC2 для использования.

accountId -> (строка)

Идентификатор учетной записи, к которой относится эта конфигурация.

setDefaultVersion -> (логическое)

Установить указанный шаблон запуска Amazon EC2 в качестве шаблона запуска по умолчанию для указанной учетной записи.

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

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

roleName -> (строка)

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

diskImageFormat -> (строка)

Экспортировать обновленное изображение в один из следующих поддерживаемых форматов образов диска:

  • Виртуальный жёсткий диск (VHD) – Совместимо с продуктами виртуализации Citrix Xen и Microsoft Hyper-V.
  • Оптимизированный для потоковой передачи ESX Virtual Machine Disk (VMDK) – Совместимо с VMware ESX и VMware vSphere версии 4, 5 и 6.
  • Сырой – Сырой формат.

s3Bucket -> (строка)

Ведро S3, в котором хранятся выходные изображения дисков для вашей виртуальной машины.

s3Prefix -> (строка)

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

fastLaunchConfigurations -> (список)

Настройки для более быстрого запуска Windows для распределения AMI.

(структура)

Определите и настройте более быстрый запуск для выходных AMI Windows.

enabled -> (логическое)

Булево значение, представляющее текущее состояние быстрого запуска для AMI Windows. Установите true, чтобы начать использовать быстрый запуск Windows, или false, чтобы прекратить его использование.

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

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

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

Количество предварительно обеспеченных снимков, которые нужно сохранить для AMI Windows с включенным быстрым запуском.

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

Максимальное количество параллельных запусков экземпляров для создания ресурсов.

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

Шаблон запуска, который использует AMI Windows с включенным быстрым запуском при запуске виртуальных машин Windows для создания предварительно обеспеченных снимков.

launchTemplateId -> (строка)

Идентификатор шаблона запуска для быстрого запуска для AMI Windows.

launchTemplateName -> (строка)

Имя шаблона запуска для быстрого запуска для AMI Windows.

launchTemplateVersion -> (строка)

Версия шаблона запуска для быстрого запуска для AMI Windows.

accountId -> (строка)

Идентификатор учетной записи владельца для AMI Windows с включенным быстрым запуском.

ssmParameterConfigurations -> (список)

Содержит настройки для обновления параметров Amazon Web Services Systems Manager (SSM) Parameter Store с выходными идентификаторами AMI из сборки по целевому региону.

(структура)

Настройка для одного параметра в Amazon Web Services Systems Manager (SSM) Parameter Store в данном регионе.

amiAccountId -> (строка)

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

parameterName -> (строка)

Это имя параметра в целевом регионе или учетной записи. Распределение изображений создаёт параметр, если он ещё не существует. В противном случае он обновляет параметр.

dataType -> (строка)

Тип данных указывает, какой тип значения содержит параметр. Мы рекомендуем использовать тип данных aws:ec2:image .

Синтаксис JSON:

[
  {
    "region": "string",
    "amiDistributionConfiguration": {
      "name": "string",
      "description": "string",
      "targetAccountIds": ["string", ...],
      "amiTags": {"string": "string"
        ...},
      "kmsKeyId": "string",
      "launchPermission": {
        "userIds": ["string", ...],
        "userGroups": ["string", ...],
        "organizationArns": ["string", ...],
        "organizationalUnitArns": ["string", ...]
      }
    },
    "containerDistributionConfiguration": {
      "description": "string",
      "containerTags": ["string", ...],
      "targetRepository": {
        "service": "ECR",
        "repositoryName": "string"
      }
    },
    "licenseConfigurationArns": ["string", ...],
    "launchTemplateConfigurations": [
      {
        "launchTemplateId": "string",
        "accountId": "string",
        "setDefaultVersion": true|false
      }
      ...
    ],
    "s3ExportConfiguration": {
      "roleName": "string",
      "diskImageFormat": "VMDK"|"RAW"|"VHD",
      "s3Bucket": "string",
      "s3Prefix": "string"
    },
    "fastLaunchConfigurations": [
      {
        "enabled": true|false,
        "snapshotConfiguration": {
          "targetResourceCount": integer
        },
        "maxParallelLaunches": integer,
        "launchTemplate": {
          "launchTemplateId": "string",
          "launchTemplateName": "string",
          "launchTemplateVersion": "string"
        },
        "accountId": "string"
      }
      ...
    ],
    "ssmParameterConfigurations": [
      {
        "amiAccountId": "string",
        "parameterName": "string",
        "dataType": "text"|"aws:ec2:image"
      }
      ...
    ]
  }
  ...
]

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

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

--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 в руководстве пользователя AWS CLI.

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

Для обновления конфигурации распределения

Следующий update-distribution-configuration пример обновляет конфигурацию распределения, используя файл JSON.

aws imagebuilder update-distribution-configuration \
    --cli-input-json file://update-distribution-configuration.json

Содержание файла update-distribution-configuration.json:

{
    "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution",
    "description": "Copies AMI to eu-west-2 and exports to S3",
    "distributions": [
        {
            "region": "us-west-2",
            "amiDistributionConfiguration": {
                "name": "Name {{imagebuilder:buildDate}}",
                "description": "An example image name with parameter references"
            }
        },
        {
            "region": "eu-west-2",
            "amiDistributionConfiguration": {
                "name": "My {{imagebuilder:buildVersion}} image {{imagebuilder:buildDate}}"
            }
        }
    ]
}

Вывод:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}

Дополнительную информацию см. в разделе Настройка и управление конвейером изображений EC2 Image Builder с помощью AWS CLI в руководстве пользователя EC2 Image Builder.

Вывод

requestId -> (строка)

Идентификатор запроса, уникально определяющий этот запрос.

clientToken -> (строка)

Маркер клиента, уникально определяющий запрос.

distributionConfigurationArn -> (строка)

Amazon Resource Name (ARN) конфигурации распределения, обновлённой этим запросом.

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

Spec-Zone.ru

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