[ aws . imagebuilder ]
получение-конфигурации-распределения
Описание
Получение конфигурации распределения.
См. также: Документация API AWS
Синтаксис
get-distribution-configuration
--distribution-configuration-arn <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 (строка)
--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 (строка)
Включить/выключить цветной вывод.
- on
- off
- auto
--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, отображающего двоичный блок 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.
Для получения подробной информации о конфигурации распределения
Следующий get-distribution-configuration пример отображает подробности конфигурации распределения, указав её ARN.
aws imagebuilder get-distribution-configuration \
--distribution-configuration-arn arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution
Вывод:
{
"requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"distributionConfiguration": {
"arn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution",
"name": "MyExampleDistribution",
"description": "Copies AMI to eu-west-1 and exports to S3",
"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"
]
}
}
}
],
"dateCreated": "2020-02-19T18:40:10.529Z",
"tags": {}
}
}
Для получения дополнительной информации см. Настройка и управление конвейером изображений EC2 Image Builder с помощью AWS CLI в руководстве пользователя EC2 Image Builder.
Вывод
requestId -> (строка)
distributionConfiguration -> (структура)
Объект конфигурации распределения.
arn -> (строка)
name -> (строка)
description -> (строка)
distributions -> (список)
Объекты распределения, применяющие региональные настройки для развертывания образа в целевых регионах.
(структура)
Определяет настройки для конкретного региона.
region -> (строка)
amiDistributionConfiguration -> (структура)
Настройки конкретного AMI; например, разрешения на запуск или теги AMI.
name -> (строка)
description -> (строка)
targetAccountIds -> (список)
Идентификатор учетной записи, в которую вы хотите распространить образ.
(строка)
amiTags -> (карта)
Теги, которые необходимо применить к AMI, распространяемым в этом регионе.
key -> (строка)
value -> (строка)
kmsKeyId -> (строка)
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 -> (строка)
accountId -> (строка)
setDefaultVersion -> (булево)
s3ExportConfiguration -> (структура)
Настройте параметры экспорта для доставки дисков образов, созданных из вашего образа сборки, используя формат файла, совместимый с вашими виртуальными машинами в этом регионе.
roleName -> (строка)
diskImageFormat -> (строка)
Экспортируйте обновленный образ в один из следующих поддерживаемых форматов дисков образов:
- Виртуальный жесткий диск (VHD) – Совместимо с продуктами виртуализации Citrix Xen и Microsoft Hyper-V.
- Виртуальный диск ESX с оптимизацией потока (VMDK) – Совместимо с VMware ESX и VMware vSphere версий 4, 5 и 6.
- Сырой – Формат сырых данных.
s3Bucket -> (строка)
s3Prefix -> (строка)
fastLaunchConfigurations -> (список)
Настройки Windows для ускоренного запуска для распределения AMI.
(структура)
Определение и настройка ускоренного запуска для выходных AMI Windows.
enabled -> (булево)
true, чтобы начать использовать ускоренный запуск Windows, или false, чтобы прекратить его использование.snapshotConfiguration -> (структура)
Настройки конфигурации для управления количеством снимков, создаваемых из предварительно подготовленных экземпляров для Windows AMI при включенном ускоренном запуске.
targetResourceCount -> (целое число)
maxParallelLaunches -> (целое число)
launchTemplate -> (структура)
Шаблон запуска, который использует Windows AMI с включенным ускоренным запуском при запуске экземпляров Windows для создания предварительно подготовленных снимков.
launchTemplateId -> (строка)
launchTemplateName -> (строка)
launchTemplateVersion -> (строка)
accountId -> (строка)
ssmParameterConfigurations -> (список)
Содержит настройки для обновления параметров Amazon Web Services Systems Manager (SSM) Parameter Store с идентификаторами выходных AMI из сборки по целевому региону.
(структура)
Конфигурация для одного параметра в Amazon Web Services Systems Manager (SSM) Parameter Store в заданном регионе.
amiAccountId -> (строка)
parameterName -> (строка)
dataType -> (строка)
aws:ec2:image .timeoutMinutes -> (целое число)
dateCreated -> (строка)
dateUpdated -> (строка)
tags -> (карта)
Теги конфигурации распределения.
key -> (строка)
value -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.