Spec-Zone.ru › AWS CLI v2

[ aws . apprunner ]

Возобновить-сервис

Описание

Возобновляет активную услугу App Runner. App Runner выделяет вычислительные ресурсы для этой службы.

Это асинхронная операция. При успешном вызове вы можете использовать возвращённые OperationId и вызов ListOperations для отслеживания прогресса операции.

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

Синтаксис

  resume-service
--service-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]

Параметры

--service-arn (строка)

Amazon Resource Name (ARN) службы App Runner, которую вы хотите возобновить.

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

Для возобновления службы

Следующий resume-service пример возобновляет службу App Runner.

aws apprunner resume-service \
    --cli-input-json file://input.json

Содержимое input.json:

{
    "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa"
}

Вывод:

{
    "OperationId": "17fe9f55-7e91-4097-b243-fcabbb69a4cf",
    "Service": {
        "CreatedAt": "2020-11-20T19:05:25Z",
        "UpdatedAt": "2020-11-23T12:41:37Z",
        "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa",
        "ServiceId": "8fe1e10304f84fd2b0df550fe98a71fa",
        "ServiceName": "python-app",
        "ServiceUrl": "psbqam834h.us-east-1.awsapprunner.com",
        "SourceConfiguration": {
            "AuthenticationConfiguration": {
                "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-connection/e7656250f67242d7819feade6800f59e"
            },
            "AutoDeploymentsEnabled": true,
            "CodeRepository": {
                "CodeConfiguration": {
                    "CodeConfigurationValues": {
                        "BuildCommand": "pip install -r requirements.txt",
                        "Port": "8080",
                        "Runtime": "PYTHON_3",
                        "RuntimeEnvironmentVariables": [
                            {
                                "NAME": "Jane"
                            }
                        ],
                        "StartCommand": "python server.py"
                    },
                    "ConfigurationSource": "Api"
                },
                "RepositoryUrl": "https://github.com/my-account/python-hello",
                "SourceCodeVersion": {
                    "Type": "BRANCH",
                    "Value": "main"
                }
            }
        },
        "Status": "OPERATION_IN_PROGRESS",
        "InstanceConfiguration": {
            "CPU": "1 vCPU",
            "Memory": "3 GB"
        }
    }
}

Вывод

Служба -> (структура)

Описание сервиса App Runner, возобновленного этим запросом.

ServiceName -> (строка)

Имя сервиса, предоставленное клиентом.

ServiceId -> (строка)

Идентификатор, сгенерированный App Runner для данного сервиса. Уникален в данном регионе Amazon Web Services.

ServiceArn -> (строка)

Amazon Resource Name (ARN) данного сервиса.

ServiceUrl -> (строка)

URL-адрес поддомена, сгенерированный App Runner для данного сервиса. Его можно использовать для доступа к веб-приложению вашего сервиса.

CreatedAt -> (метка времени)

Время создания сервиса App Runner. Формат — Unix timestamp.

UpdatedAt -> (метка времени)

Время последнего обновления сервиса App Runner. Формат — Unix timestamp.

DeletedAt -> (метка времени)

Время удаления сервиса App Runner. Формат — Unix timestamp.

Status -> (строка)

Текущее состояние сервиса App Runner. Эти значения означают следующее.

  • CREATE_FAILED – Сервис не был создан. Неудачный сервис не используется, но всё ещё учитывается в лимите сервисов. Чтобы устранить ошибку, прочитайте события и логи ошибки, измените необходимые параметры и перестройте сервис с помощью UpdateService .
  • DELETE_FAILED – Сервис не был удалён и не может быть успешно восстановлен. Повторите вызов удаления сервиса, чтобы убедиться в удалении всех связанных ресурсов.

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

Исходный код, развернутый в сервис App Runner. Может быть кодом или образом.

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

Описание репозитория исходного кода.

Вы должны указать либо этот элемент, либо ImageRepository (но не оба).

RepositoryUrl -> (строка)

Расположение репозитория, содержащего исходный код.

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

Версия, которая должна быть использована в репозитории исходного кода.

Type -> (строка)

Тип идентификатора версии.

Для репозиториев на основе Git ветки представляют версии.

Value -> (строка)

Версия исходного кода.

Для репозиториев на основе Git имя ветки сопоставляется со специфической версией. App Runner использует последний коммит в ветке.

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

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

Примечание

CodeConfiguration требуется только для запроса CreateService .

ConfigurationSource -> (строка)

Источник конфигурации App Runner. Значения интерпретируются следующим образом:

  • REPOSITORY – App Runner считывает значения конфигурации из файла apprunner.yaml в репозитории исходного кода и игнорирует CodeConfigurationValues .
  • API – App Runner использует значения конфигурации из CodeConfigurationValues и игнорирует файл apprunner.yaml в репозитории исходного кода.

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

Основные настройки для сборки и запуска сервиса App Runner. Используйте их для быстрого запуска сервиса App Runner без предоставления файла apprunner.yaml в репозитории исходного кода (или игнорирования файла, если он существует).

Runtime -> (строка)

Тип среды выполнения для сборки и запуска сервиса App Runner. Представляет среду выполнения языка программирования.

BuildCommand -> (строка)

Команда, которую App Runner выполняет для сборки вашего приложения.

StartCommand -> (строка)

Команда, которую App Runner выполняет для запуска вашего приложения.

Port -> (строка)

Порт, на котором ваше приложение слушает в контейнере.

По умолчанию: 8080

RuntimeEnvironmentVariables -> (массив)

Переменные среды, доступные для вашего работающего сервиса App Runner. Массив пар ключ-значение.

key -> (строка)

value -> (строка)

RuntimeEnvironmentSecrets -> (массив)

Массив пар ключ-значение, представляющий секреты и параметры, которые ссылаются на ваш сервис в качестве переменной среды. Поддерживаются полные Amazon Resource Name (ARN) секретов Secrets Manager или параметров Amazon Web Services Systems Manager Parameter Store.

Примечание

  • Если параметр Amazon Web Services Systems Manager Parameter Store существует в том же регионе Amazon Web Services, что и запускаемый сервис, вы можете использовать полный ARN или имя секрета. Если параметр находится в другом регионе, должен быть указан полный ARN.
  • В настоящее время не поддерживается ссылка на параметры Amazon Web Services Systems Manager Parameter Store в разных учётных записях.

key -> (строка)

value -> (строка)

SourceDirectory -> (строка)

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

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

Описание репозитория с изображением.

Вы должны указать либо этот элемент, либо CodeRepository (но не оба).

ImageIdentifier -> (строка)

Идентификатор образа.

Для образа в Amazon Elastic Container Registry (Amazon ECR) это имя образа. Формат имени образа см. в разделе «Извлечение образа» в руководстве пользователя Amazon ECR.

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

Настройка для запуска указанного образа.

RuntimeEnvironmentVariables -> (массив)

Переменные среды, доступные для работающего сервиса App Runner. Массив пар ключ-значение.

key -> (строка)

value -> (строка)

StartCommand -> (строка)

Необязательная команда, которую App Runner выполняет для запуска приложения в исходном изображении. Если указана, эта команда переопределяет команду запуска по умолчанию Docker-образа.

Port -> (строка)

Порт, на котором ваше приложение слушает в контейнере.

По умолчанию: 8080

RuntimeEnvironmentSecrets -> (массив)

Массив пар ключ-значение, представляющий секреты и параметры, которые ссылаются на ваш сервис в качестве переменной среды. Поддерживаются полные Amazon Resource Name (ARN) секретов Secrets Manager или параметров Amazon Web Services Systems Manager Parameter Store.

Примечание

  • Если параметр Amazon Web Services Systems Manager Parameter Store существует в том же регионе Amazon Web Services, что и запускаемый сервис, вы можете использовать полный ARN или имя секрета. Если параметр находится в другом регионе, должен быть указан полный ARN.
  • В настоящее время не поддерживается ссылка на параметры Amazon Web Services Systems Manager Parameter Store в разных учётных записях.

key -> (строка)

value -> (строка)

ImageRepositoryType -> (строка)

Тип репозитория изображений. Отражает провайдера репозитория и является ли репозиторий частным или публичным.

AutoDeploymentsEnabled -> (булево)

Если true , непрерывная интеграция из репозитория исходного кода включена для сервиса App Runner. Каждое изменение репозитория (включая любые изменения исходного кода или новую версию образа) запускает развертывание.

По умолчанию: App Runner устанавливает значение на false для образа, использующего публичный репозиторий ECR или репозиторий ECR в другой учётной записи Amazon Web Services, чем у сервиса. App Runner устанавливает значение на true во всех остальных случаях (включая репозиторий исходного кода или образ, использующий репозиторий ECR в той же учётной записи).

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

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

ConnectionArn -> (строка)

Amazon Resource Name (ARN) подключения App Runner, которое позволяет сервису App Runner подключаться к репозиторию исходного кода. Требуется для репозиториев GitHub.

AccessRoleArn -> (строка)

Amazon Resource Name (ARN) роли IAM, которая предоставляет сервису App Runner доступ к репозиторию исходного кода. Требуется для репозиториев изображений ECR (но не для публичных репозиториев ECR).

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

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

Cpu -> (строка)

Количество процессорных единиц, резервируемых для каждого экземпляра вашего сервиса App Runner.

По умолчанию: 1 vCPU

Memory -> (строка)

Объем памяти в МБ или ГБ, резервируемый для каждого экземпляра вашего сервиса App Runner.

По умолчанию: 2 GB

InstanceRoleArn -> (строка)

Amazon Resource Name (ARN) роли IAM, предоставляющей разрешения вашему сервису App Runner. Это разрешения, необходимые вашему коду при вызовах любых API Amazon Web Services.

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

Ключ шифрования, который App Runner использует для шифрования журналов сервиса и копии репозитория исходного кода, которую App Runner поддерживает для сервиса. Может быть собственным ключом шифрования клиента или управляемым ключом Amazon Web Services.

KmsKey -> (строка)

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

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

Настройки проверки работоспособности, выполняемой App Runner для мониторинга работоспособности этого сервиса.

Protocol -> (строка)

IP-протокол, который App Runner использует для проверки работоспособности вашего сервиса.

Если вы установите Protocol в HTTP , App Runner отправляет запросы проверки работоспособности по указанному в Path HTTP-пути.

По умолчанию: TCP

Path -> (строка)

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

Path применимо только тогда, когда вы устанавливаете Protocol в HTTP .

По умолчанию: "/"

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

Интервал времени в секундах между проверками работоспособности.

По умолчанию: 5

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

Время в секундах ожидания ответа проверки работоспособности до определения его как неисправного.

По умолчанию: 2

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

Количество последовательных успешных проверок, необходимых App Runner для определения сервиса как работоспособного.

По умолчанию: 1

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

Количество последовательных неудачных проверок, необходимых App Runner для определения сервиса как неработоспособного.

По умолчанию: 5

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

Сводная информация о ресурсе автоматического масштабирования App Runner, связанном с этим сервисом.

AutoScalingConfigurationArn -> (строка)

Идентификатор ресурса Amazon (ARN) этой конфигурации автоматического масштабирования.

AutoScalingConfigurationName -> (строка)

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

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

Ревизия этой конфигурации автоматического масштабирования. Она уникальна среди всех активных конфигураций ("Status": "ACTIVE" ) с тем же AutoScalingConfigurationName .

Status -> (строка)

Текущее состояние конфигурации автоматического масштабирования. Если статус ревизии конфигурации равен INACTIVE , она была удалена и больше не может использоваться. Неактивные ревизии конфигурации удаляются навсегда некоторое время после удаления.

CreatedAt -> (метка времени)

Время создания конфигурации автоматического масштабирования. Формат — метка времени Unix.

HasAssociatedService -> (булево)

Указывает, имеет ли эта конфигурация автоматического масштабирования связанный с ней сервис App Runner. Значение true указывает, что связан один или несколько сервисов. Значение false указывает, что сервисы не связаны.

IsDefault -> (булево)

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

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

Настройки конфигурации, относящиеся к сетевому трафику веб-приложения, которое выполняет этот сервис.

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

Настройки сетевой конфигурации для исходящего трафика сообщений.

EgressType -> (строка)

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

Установлено в DEFAULT для доступа к ресурсам, размещенным в общедоступных сетях.

Установлено в VPC для привязки сервиса к настраиваемой сети VPC, указанной параметром VpcConnectorArn .

VpcConnectorArn -> (строка)

Идентификатор ресурса Amazon (ARN) коннектора VPC App Runner, который вы хотите связать со своим сервисом App Runner. Действительно только при значении EgressType = VPC .

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

Настройки сетевой конфигурации для входящего трафика сообщений.

IsPubliclyAccessible -> (булево)

Указывает, доступен ли ваш сервис App Runner публично. Установите в True для публичного доступа к сервису. Установите в False для доступа к сервису только из внутри сети Amazon VPC.

IpAddressType -> (строка)

App Runner предоставляет вам возможность выбрать между Internet Protocol версии 4 (IPv4) и двойным стеком (IPv4 и IPv6) для вашей конфигурации входящей общедоступной сети. Это необязательный параметр. Если вы не укажете IpAddressType , по умолчанию выбирается IPv4.

Примечание

В настоящее время App Runner поддерживает двойной стек только для общедоступных конечных точек. Только IPv4 поддерживается для частных конечных точек. Если вы обновите сервис, использующий двойной стек общедоступных конечных точек, на частную конечную точку, ваш сервис App Runner будет по умолчанию поддерживать только IPv4 для частной конечной точки и не сможет получать трафик, исходящий от IPv6-конечной точки.

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

Конфигурация наблюдаемости этого сервиса.

ObservabilityEnabled -> (булево)

При значении true с сервисом ассоциируется ресурс конфигурации наблюдаемости и указывается ObservabilityConfigurationArn .

ObservabilityConfigurationArn -> (строка)

Идентификатор ресурса Amazon (ARN) конфигурации наблюдаемости, связанной с сервисом. Указывается только при значении ObservabilityEnabled равно true .

Укажите ARN с именем и номером ревизии, чтобы связать эту ревизию. Например: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/3

Укажите только имя, чтобы связать последнюю ревизию. Например: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing

OperationId -> (строка)

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

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

Spec-Zone.ru

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