get-deployment-group

Описание

Получает информацию о группе развертывания.

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

Синтаксис

  get-deployment-group
--application-name <value>
--deployment-group-name <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]

Параметры

--application-name (строка)

Имя приложения CodeDeploy, связанного с пользователем или учетной записью Amazon Web Services.

--deployment-group-name (строка)

Имя группы развертывания для указанного приложения.

--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
таблица
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-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Примеры

Примечание

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

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

Для просмотра информации о группе развертывания

Следующий get-deployment-group пример отображает информацию о группе развертывания, связанной с указанным приложением.

aws deploy get-deployment-group \
    --application-name WordPress_App \
    --deployment-group-name WordPress_DG

Вывод:

{
    "deploymentGroupInfo": {
        "applicationName": "WordPress_App",
        "autoScalingGroups": [
            "CodeDeployDemo-ASG"
        ],
        "deploymentConfigName": "CodeDeployDefault.OneAtATime",
        "ec2TagFilters": [
            {
                "Type": "KEY_AND_VALUE",
                "Value": "CodeDeployDemo",
                "Key": "Name"
            }
        ],
        "deploymentGroupId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
        "serviceRoleArn": "arn:aws:iam::123456789012:role/CodeDeployDemoRole",
        "deploymentGroupName": "WordPress_DG"
    }
}

Вывод

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

Информация о группе развертывания.

applicationName -> (строка)

Имя приложения.

deploymentGroupId -> (строка)

Идентификатор группы развертывания.

deploymentGroupName -> (строка)

Название группы развертывания.

deploymentConfigName -> (строка)

Имя конфигурации развертывания.

ec2TagFilters -> (список)

Теги Amazon EC2, по которым необходимо фильтровать. Группа развертывания включает экземпляры EC2 со всеми указанными тегами.

(структура)

Информация о фильтре тегов EC2.

Key -> (строка)

Ключ фильтра тегов.

Value -> (строка)

Значение фильтра тегов.

Type -> (строка)

Тип фильтра тегов:

KEY_ONLY : Только ключ.
VALUE_ONLY : Только значение.
KEY_AND_VALUE : Ключ и значение.

onPremisesInstanceTagFilters -> (список)

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

(структура)

Информация о фильтре тегов локального экземпляра.

Key -> (строка)

Ключ фильтра тегов локального экземпляра.

Value -> (строка)

Значение фильтра тегов локального экземпляра.

Type -> (строка)

Тип фильтра тегов локального экземпляра:

KEY_ONLY: Только ключ.
VALUE_ONLY: Только значение.
KEY_AND_VALUE: Ключ и значение.

autoScalingGroups -> (список)

Список связанных групп Auto Scaling.

(структура)

Информация о группе Auto Scaling.

name -> (строка)

Имя группы Auto Scaling.

hook -> (строка)

Имя запускаемого хука, установленного CodeDeploy в группе Auto Scaling.

Дополнительную информацию о запускаемом хуке см. в разделе Как Amazon EC2 Auto Scaling работает с CodeDeploy в Руководстве пользователя CodeDeploy.

terminationHook -> (строка)

Имя хука завершения, установленного CodeDeploy в группе Auto Scaling.

Дополнительную информацию о хуке завершения см. в разделе Включение развертываний при завершении во время событий масштабирования Auto Scaling в Руководстве пользователя CodeDeploy.

serviceRoleArn -> (строка)

Amazon Resource Name (ARN) роли службы, предоставляющей CodeDeploy разрешение на вызовы к службам Amazon Web Services от вашего имени. Дополнительную информацию см. в разделе Создание роли службы для CodeDeploy в Руководстве пользователя CodeDeploy.

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

Информация о целевой ревизии группы развертывания, включая тип и расположение.

revisionType -> (строка)

Тип ревизии приложения:

S3: Ревизия приложения, хранящаяся в Amazon S3.
GitHub: Ревизия приложения, хранящаяся в GitHub (только развертывания EC2/локальные).
String: Строка в формате YAML или JSON (только развертывания Lambda).
AppSpecContent: AppSpecContent объект, содержащий содержимое файла AppSpec для развертывания Lambda или Amazon ECS. Содержимое отформатировано как JSON или YAML и хранится как RawString.

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

Информация о расположении ревизии, хранящейся в Amazon S3.

bucket -> (строка)

Имя ведра Amazon S3, в котором хранится ревизия приложения.

key -> (строка)

Имя объекта Amazon S3, представляющего упакованные артефакты для ревизии приложения.

bundleType -> (строка)

Тип файла ревизии приложения. Должно быть одно из следующих значений:

tar : Файл архива tar.
tgz : Сжатый файл архива tar.
zip : Файл архива zip.
YAML : Файл в формате YAML.
JSON : Файл в формате JSON.

version -> (строка)

Конкретная версия объекта Amazon S3, представляющего упакованные артефакты для ревизии приложения.

Если версия не указана, система по умолчанию использует последнюю версию.

eTag -> (строка)

ETag объекта Amazon S3, представляющего упакованные артефакты для ревизии приложения.

Если ETag не указан в качестве входного параметра, проверка ETag объекта пропускается.

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

Информация о расположении артефактов приложения, хранящихся в GitHub.

repository -> (строка)

Пара GitHub учетной записи и репозитория, хранящая ссылку на коммит, представляющий упакованные артефакты для ревизии приложения.

Указывается в формате account/repository.

commitId -> (строка)

Идентификатор SHA1 коммита GitHub, представляющий упакованные артефакты для ревизии приложения.

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

Информация о расположении ревизии развертывания Lambda, хранящейся как RawString.

content -> (строка)

Строка ревизии в формате YAML или JSON. Она содержит информацию о том, какую функцию Lambda обновить, и необязательные функции Lambda, которые валидируют события жизненного цикла развертывания.

sha256 -> (строка)

Значение хэша SHA256 содержимого ревизии.

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

Содержимое файла AppSpec для развертывания Lambda или Amazon ECS. Содержимое отформатировано как JSON или YAML и хранится как RawString.

content -> (строка)

Строка ревизии в формате YAML или JSON.

Для развертывания Lambda содержимое включает имя функции Lambda, алиас для ее исходной версии и алиас для заменяющей версии. Развертывание переключает трафик с исходной версии функции Lambda на заменяющую версию.

Для развертывания Amazon ECS содержимое включает имя задачи, информацию о балансировщике нагрузки, который обслуживает трафик контейнеру и т.д.

Для обоих типов развертываний содержимое может указывать функции Lambda, которые выполняются на определенных хуках, таких как BeforeInstall , во время развертывания.

sha256 -> (строка)

Значение хэша SHA256 содержимого ревизии.

triggerConfigurations -> (список)

Информация о триггерах, связанных с группой развертывания.

(структура)

Информация о триггерах уведомлений для группы развертывания.

triggerName -> (строка)

Имя триггера уведомления.

triggerTargetArn -> (строка)

Amazon Resource Name (ARN) темы Amazon Simple Notification Service, через которую отправляются уведомления о событиях развертывания или экземпляров.

triggerEvents -> (список)

Тип или типы событий, по которым срабатывают уведомления.

(строка)

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

Список тревог, связанных с группой развертывания.

enabled -> (булево)

Указывает, включена ли конфигурация тревоги.

ignorePollAlarmFailure -> (булево)

Указывает, должен ли развертывание продолжаться, если информация о текущем состоянии тревог не может быть получена из Amazon CloudWatch. Значение по умолчанию — false.

true : Развертывание продолжается, даже если информация о состоянии тревоги не может быть получена из Amazon CloudWatch.
false : Развертывание останавливается, если информация о состоянии тревоги не может быть получена из Amazon CloudWatch.

alarms -> (список)

Список тревог, настроенных для развертывания или группы развертывания. Максимальное количество тревог — 10.

(структура)

Информация об тревоге.

name -> (строка)

Имя тревоги. Максимальная длина — 255 символов. Каждое имя тревоги может быть использовано только один раз в списке тревог.

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

Информация об автоматической конфигурации отката, связанной с группой развертывания.

enabled -> (булево)

Указывает, включена ли определённая автоматическая конфигурация отката.

events -> (список)

Тип или типы событий, которые запускают откат.

(строка)

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

Информация о типе развертывания (на месте или синие/зелёные) и о том, следует ли направлять трафик развертывания за балансировщиком нагрузки.

deploymentType -> (строка)

Указывает, необходимо ли выполнить развертывание на месте или синие/зелёное развертывание.

deploymentOption -> (строка)

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

outdatedInstancesStrategy -> (строка)

Указывает, что происходит, когда новые экземпляры Amazon EC2 запускаются во время развертывания и не получают развернутую ревизию приложения.

Если этот параметр установлен на UPDATE или не указан, CodeDeploy инициирует одно или несколько развертываний «автоматическое обновление устаревших экземпляров», чтобы применить развернутую ревизию приложения к новым экземплярам Amazon EC2.

Если этот параметр установлен на IGNORE , CodeDeploy не инициирует развертывание для обновления новых экземпляров Amazon EC2. Это может привести к тому, что у экземпляров будут разные ревизии.

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

Информация о вариантах развертывания blue/green для группы развертывания.

terminateBlueInstancesOnDeploymentSuccess -> (structure)

Информация о том, следует ли завершать работу экземпляров в исходном флоте во время развертывания blue/green.

action -> (string)

Действие, которое нужно выполнить над экземплярами в исходной среде после успешного развертывания blue/green.

TERMINATE : Экземпляры завершаются после указанного времени ожидания.
KEEP_ALIVE : Экземпляры остаются активными после их от регистрации из балансировщика нагрузки и удаления из группы развертывания.

terminationWaitTimeInMinutes -> (integer)

Для развертывания Amazon EC2 количество минут, которые необходимо подождать после успешного развертывания blue/green перед завершением работы экземпляров из исходной среды.

Для развертывания Amazon ECS количество минут, которые необходимо подождать перед удалением исходного (синего) набора задач. Во время развертывания Amazon ECS CodeDeploy переключает трафик с исходного (синего) набора задач на заменяющий (зеленый) набор задач.

Максимальное значение — 2880 минут (2 дня).

deploymentReadyOption -> (structure)

Информация о действии, которое следует выполнить, когда новые экземпляры готовы принимать трафик в развертывании blue/green.

actionOnTimeout -> (string)

Информация о том, когда перенаправить трафик из исходной среды в заменяющую среду при развертывании blue/green.

CONTINUE_DEPLOYMENT: Немедленно зарегистрировать новые экземпляры с балансировщиком нагрузки после установки новой ревизии приложения на экземпляры в заменяющей среде.
STOP_DEPLOYMENT: Не регистрировать новые экземпляры с балансировщиком нагрузки, пока перенаправление трафика не будет начато с помощью ContinueDeployment . Если перенаправление трафика не будет начато до истечения указанного периода ожидания, статус развертывания будет изменён на Stopped.

waitTimeInMinutes -> (integer)

Количество минут ожидания, прежде чем статус развертывания blue/green будет изменён на Stopped, если перенаправление трафика не будет начато вручную. Применяется только к варианту STOP_DEPLOYMENT для actionOnTimeout .

greenFleetProvisioningOption -> (structure)

Информация о том, как предоставляются экземпляры для заменяющей среды при развертывании blue/green.

action -> (string)

Метод добавления экземпляров в заменяющую среду.

DISCOVER_EXISTING : Использовать уже существующие или те, что будут созданы вручную.
COPY_AUTO_SCALING_GROUP : Использовать параметры из указанной группы Auto Scaling для определения и создания экземпляров в новой группе Auto Scaling.

loadBalancerInfo -> (structure)

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

elbInfoList -> (list)

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

Примечание

Вы можете добавить до 10 балансировщиков в массив.

Примечание

Если вы используете Application Load Balancers или Network Load Balancers, используйте массив targetGroupInfoList вместо этого.

(structure)

Информация о классическом балансировщике нагрузки Elastic Load Balancing для использования при развертывании. Экземпляры регистрируются непосредственно у балансировщика нагрузки, и трафик маршрутизируется к балансировщику.

name -> (string)

Для развертываний blue/green — имя классического балансировщика нагрузки, который используется для маршрутизации трафика с исходных экземпляров на заменяющие экземпляры. Для развертываний in-place — имя классического балансировщика нагрузки, с которого экземпляры отключаются, чтобы они не обрабатывали трафик во время развертывания, а затем снова регистрируются после завершения развертывания.

targetGroupInfoList -> (list)

Массив, содержащий информацию о группах целевых экземпляров, которые необходимо использовать для балансировки нагрузки при развертывании. Если вы используете Application Load Balancers и Network Load Balancers, укажите их связанные группы целевых экземпляров в этом массиве.

Примечание

Вы можете добавить до 10 групп целевых экземпляров в массив.

Примечание

Если вы используете классические балансировщики, используйте массив elbInfoList вместо этого.

(structure)

Информация о группе целевых экземпляров в Elastic Load Balancing для использования при развертывании. Экземпляры регистрируются как цели в группе целевых экземпляров, и трафик маршрутизируется к группе целевых экземпляров.

name -> (string)

Для развертываний blue/green — имя группы целевых экземпляров, с которой отключаются экземпляры в исходной среде, и к которой регистрируются экземпляры в заменяющей среде. Для развертываний in-place — имя группы целевых экземпляров, с которой отключаются экземпляры, чтобы они не обрабатывали трафик во время развертывания, а затем снова регистрируются после завершения развертывания.

targetGroupPairInfoList -> (list)

Информация о паре групп целевых экземпляров. Это массив объектов TargeGroupPairInfo максимального размера один.

(structure)

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

targetGroups -> (list)

Одна пара групп целевых экземпляров. Одна связана с исходным набором задач. Вторая — с набором задач, обрабатывающим трафик после завершения развертывания.

(structure)

name -> (string)

prodTrafficRoute -> (structure)

Путь, используемый балансировщиком нагрузки для маршрутизации производственного трафика после завершения развертывания Amazon ECS.

listenerArns -> (list)

Amazon Resource Name (ARN) одного слушателя. Слушатель определяет маршрут между группой целевых экземпляров и балансировщиком нагрузки. Это массив строк максимального размера один.

(string)

testTrafficRoute -> (structure)

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

listenerArns -> (list)

(string)

lastSuccessfulDeployment -> (structure)

Информация о последнем успешном развертывании в группе развертывания.

deploymentId -> (string)

Уникальный идентификатор развертывания.

status -> (string)

Статус последнего развертывания.

endTime -> (timestamp)

Отметка времени, указывающая, когда последнее развертывание в группе развертывания было завершено.

createTime -> (timestamp)

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

lastAttemptedDeployment -> (structure)

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

deploymentId -> (string)

Уникальный идентификатор развертывания.

status -> (string)

Статус последнего развертывания.

endTime -> (timestamp)

Отметка времени, указывающая, когда последнее развертывание в группе развертывания было завершено.

createTime -> (timestamp)

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

ec2TagSet -> (structure)

Информация о группах тегов, применённых к экземпляру Amazon EC2. В группе развертывания включены только экземпляры Amazon EC2, идентифицируемые по всем группам тегов. Нельзя использовать в одном вызове вместе с ec2TagFilters.

ec2TagSetList -> (list)

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

(list)

(structure)

Информация о фильтре тегов EC2.

Key -> (string)

Ключ фильтра тегов.

Value -> (string)

Значение фильтра тегов.

Type -> (string)

Тип фильтра тегов:

KEY_ONLY : Только ключ.
VALUE_ONLY : Только значение.
KEY_AND_VALUE : Ключ и значение.

onPremisesTagSet -> (structure)

Информация о группах тегов, применённых к локальному экземпляру. В группе развертывания включены только локальные экземпляры, идентифицируемые по всем группам тегов. Нельзя использовать в одном вызове вместе с onPremisesInstanceTagFilters.

onPremisesTagSetList -> (list)

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

(list)

(structure)

Информация о фильтре тегов локального экземпляра.

Key -> (string)

Ключ фильтра тегов локального экземпляра.

Value -> (string)

Значение фильтра тегов локального экземпляра.

Type -> (string)

Тип фильтра тегов локального экземпляра:

KEY_ONLY: Только ключ.
VALUE_ONLY: Только значение.
KEY_AND_VALUE: Ключ и значение.

computePlatform -> (string)

Тип целевой платформы развертывания (Lambda , Server или ECS ).

ecsServices -> (list)

Целевые Amazon ECS службы в группе развертывания. Это относится только к группам развертывания, использующим платформу вычислений Amazon ECS. Целевая Amazon ECS служба задаётся как пара имени кластера и службы Amazon ECS в формате <clustername>:<servicename> .

(structure)

Содержит имена службы и кластера, используемые для идентификации целевого объекта развертывания Amazon ECS.

serviceName -> (string)

Имя целевой Amazon ECS службы.

clusterName -> (string)

Имя кластера, с которым связана Amazon ECS служба.

terminationHookEnabled -> (boolean)

Указывает, была ли группа развертывания настроена на установку CodeDeploy крючка завершения в группе Auto Scaling.

Дополнительную информацию о крючке завершения см. в разделе Как Amazon EC2 Auto Scaling работает с CodeDeploy в Руководстве пользователя CodeDeploy.