Spec-Zone.ru › AWS CLI v2

[ aws . apprunner ]

pause-service

Описание

Приостановить активную службу App Runner. App Runner уменьшает вычислительную мощность службы до нуля и теряет состояние (например, удаляется временное хранилище).

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

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

Синтаксис

  pause-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
  • текст
  • таблица
  • 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 для вывода.

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

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

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

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

Примеры

Примечание

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

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

Чтобы приостановить службу

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

aws apprunner pause-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 для данного сервиса. Вы можете использовать этот URL для доступа к веб-приложению вашего сервиса.

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

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

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

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

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

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

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, либо полный ARN параметра в 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, либо полный ARN параметра в 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. Для обеспечения частного доступа только из сети Amazon VPC установите значение в False.

IpAddressType -> (строка)

App Runner предоставляет вам возможность выбора между Интернет-протоколом версии 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