Spec-Zone.ru › AWS CLI v2

[ aws . imagebuilder ]

создать-конфигурацию-распределения

Описание

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

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

Синтаксис

  create-distribution-configuration
--name <value>
[--description <value>]
--distributions <value>
[--tags <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]

Параметры

--name (строка)

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

--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 -> (список)

Конфигурация License Manager для ассоциации с AMI в указанном регионе.

(строка)

launchTemplateConfigurations -> (список)

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

(структура)

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

launchTemplateId -> (строка)

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

accountId -> (строка)

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

setDefaultVersion -> (булево)

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

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

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

roleName -> (строка)

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

diskImageFormat -> (строка)

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

  • Virtual Hard Disk (VHD) — Совместимо с Citrix Xen и Microsoft Hyper-V продуктами виртуализации.
  • Stream-optimized ESX Virtual Machine Disk (VMDK) — Совместимо с VMware ESX и VMware vSphere версиями 4, 5 и 6.
  • Raw — Формат Raw.

s3Bucket -> (строка)

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

s3Prefix -> (строка)

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

fastLaunchConfigurations -> (список)

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

(структура)

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

enabled -> (булево)

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

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

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

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 с выходными ID 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"
      }
      ...
    ]
  }
  ...
]

--tags (карта)

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

key -> (строка)

value -> (строка)

Краткая форма синтаксиса:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--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 (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-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Примеры

Примечание

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

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

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

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

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

Содержимое create-distribution-configuration.json:

{
    "name": "MyExampleDistribution",
    "description": "Copies AMI to eu-west-1",
    "distributions": [
        {
            "region": "us-west-2",
            "amiDistributionConfiguration": {
                "name": "Name {{imagebuilder:buildDate}}",
                "description": "An example image name with parameter references",
                "amiTags": {
                    "KeyName": "{{ssm:parameter_name}}"
                },
                "launchPermission": {
                    "userIds": [
                        "123456789012"
                    ]
                }
            }
        },
        {
            "region": "eu-west-1",
            "amiDistributionConfiguration": {
                "name": "My {{imagebuilder:buildVersion}} image {{imagebuilder:buildDate}}",
                "amiTags": {
                    "KeyName": "Value"
                },
                "launchPermission": {
                    "userIds": [
                        "123456789012"
                    ]
                }
            }
        }
    ]
}

Вывод:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
    "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution"
}

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

Вывод

requestId -> (string)

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

clientToken -> (string)

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

distributionConfigurationArn -> (string)

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

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

Spec-Zone.ru

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