Spec-Zone.ru › AWS CLI v2

[ aws . apprunner ]

удалить-сервис

Описание

Удалить сервис App Runner.

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

Примечание

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

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

Синтаксис

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

Для удаления сервиса

Следующий delete-service пример удаляет сервис App Runner.

aws apprunner delete-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-20T19:05:25Z",
        "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 -> (строка)

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

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 или параметра в 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 отправляет запросы проверки состояния на HTTP-путь, указанный в Path .

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

Path -> (строка)

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

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