Spec-Zone.ru › AWS CLI v2

[ aws . apprunner ]

update-service

Описание

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

Для обновления тегов, примененных к вашему сервису, используйте отдельные действия TagResource и UntagResource.

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

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

Синтаксис

  update-service
--service-arn <value>
[--source-configuration <value>]
[--instance-configuration <value>]
[--auto-scaling-configuration-arn <value>]
[--health-check-configuration <value>]
[--network-configuration <value>]
[--observability-configuration <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, который вы хотите обновить.

--source-configuration (структура)

Конфигурация источника, которую нужно применить к сервису App Runner.

Вы можете изменить конфигурацию кода или репозитория изображений, используемых сервисом. Однако вы не можете переключиться с кода на изображение или наоборот. Это означает, что вы должны предоставить тот же член структуры, что и при создании сервиса. То есть, вы можете указать либо CodeRepository, либо ImageRepository. Для обновления конфигурации источника установите значения в члены структуры, которую вы включаете.

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

Синтаксис JSON:

{
  "CodeRepository": {
    "RepositoryUrl": "string",
    "SourceCodeVersion": {
      "Type": "BRANCH",
      "Value": "string"
    },
    "CodeConfiguration": {
      "ConfigurationSource": "REPOSITORY"|"API",
      "CodeConfigurationValues": {
        "Runtime": "PYTHON_3"|"NODEJS_12"|"NODEJS_14"|"CORRETTO_8"|"CORRETTO_11"|"NODEJS_16"|"GO_1"|"DOTNET_6"|"PHP_81"|"RUBY_31"|"PYTHON_311"|"NODEJS_18"|"NODEJS_22",
        "BuildCommand": "string",
        "StartCommand": "string",
        "Port": "string",
        "RuntimeEnvironmentVariables": {"string": "string"
          ...},
        "RuntimeEnvironmentSecrets": {"string": "string"
          ...}
      }
    },
    "SourceDirectory": "string"
  },
  "ImageRepository": {
    "ImageIdentifier": "string",
    "ImageConfiguration": {
      "RuntimeEnvironmentVariables": {"string": "string"
        ...},
      "StartCommand": "string",
      "Port": "string",
      "RuntimeEnvironmentSecrets": {"string": "string"
        ...}
    },
    "ImageRepositoryType": "ECR"|"ECR_PUBLIC"
  },
  "AutoDeploymentsEnabled": true|false,
  "AuthenticationConfiguration": {
    "ConnectionArn": "string",
    "AccessRoleArn": "string"
  }
}

--instance-configuration (структура)

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

Cpu -> (строка)

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

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

Memory -> (строка)

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

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

InstanceRoleArn -> (строка)

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

Краткая запись синтаксиса:

Cpu=string,Memory=string,InstanceRoleArn=string

Синтаксис JSON:

{
  "Cpu": "string",
  "Memory": "string",
  "InstanceRoleArn": "string"
}

--auto-scaling-configuration-arn (строка)

Amazon Resource Name (ARN) ресурса конфигурации автоматического масштабирования App Runner, который вы хотите связать с сервисом App Runner.

--health-check-configuration (структура)

Настройки проверки работоспособности, которые App Runner выполняет для мониторинга работоспособности сервиса 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

Краткая запись синтаксиса:

Protocol=string,Path=string,Interval=integer,Timeout=integer,HealthyThreshold=integer,UnhealthyThreshold=integer

Синтаксис JSON:

{
  "Protocol": "TCP"|"HTTP",
  "Path": "string",
  "Interval": integer,
  "Timeout": integer,
  "HealthyThreshold": integer,
  "UnhealthyThreshold": integer
}

--network-configuration (структура)

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

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

Примечание

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

Сокращенная синтаксическая запись:

EgressConfiguration={EgressType=string,VpcConnectorArn=string},IngressConfiguration={IsPubliclyAccessible=boolean},IpAddressType=string

Синтаксис JSON:

{
  "EgressConfiguration": {
    "EgressType": "DEFAULT"|"VPC",
    "VpcConnectorArn": "string"
  },
  "IngressConfiguration": {
    "IsPubliclyAccessible": true|false
  },
  "IpAddressType": "IPV4"|"DUAL_STACK"
}

--observability-configuration (структура)

Настройка наблюдаемости вашей службы.

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

Сокращенная синтаксическая запись:

ObservabilityEnabled=boolean,ObservabilityConfigurationArn=string

Синтаксис JSON:

{
  "ObservabilityEnabled": true|false,
  "ObservabilityConfigurationArn": "string"
}

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

Обновление размера памяти

В следующем update-service примере обновляется размер памяти экземпляров (масштабируемых единиц) службы App Runner до 2048 МБ.

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

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

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

{
    "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa",
    "InstanceConfiguration": {
        "Memory": "4 GB"
    }
}

Вывод:

{
    "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": "4 GB"
        }
    }
}

Вывод

Сервис -> (структура)

Описание обновленного сервиса App Runner, полученное в результате этого запроса. Все значения конфигурации в возвращаемой Service структуре отражают изменения конфигурации, применяемые данным запросом.

ИмяСервиса -> (строка)

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

ИдентификаторСервиса -> (строка)

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

ARNСервиса -> (строка)

Amazon Resource Name (ARN) этого сервиса.

URLСервиса -> (строка)

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

ДатаСоздание -> (временная метка)

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

ДатаОбновления -> (временная метка)

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

ДатаУдаления -> (временная метка)

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

Статус -> (строка)

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

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

КонфигурацияИсточника -> (структура)

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

РепозиторийКода -> (структура)

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

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

URLРепозитория -> (строка)

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

ВерсияИсходногоКода -> (структура)

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

Тип -> (строка)

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

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

Значение -> (строка)

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

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

КонфигурацияКода -> (структура)

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

Примечание

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

ИсточникКонфигурации -> (строка)

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

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

ЗначенияКонфигурацииКода -> (структура)

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

Средство выполнения -> (строка)

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

КомандаСборки -> (строка)

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

КомандаЗапуска -> (строка)

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

Порт -> (строка)

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

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

ПеременныеСредыВыполнения -> (карта)

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

ключ -> (строка)

значение -> (строка)

СекретыСредыВыполнения -> (карта)

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

Примечание

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

ключ -> (строка)

значение -> (строка)

ДиректорияИсточника -> (строка)

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

РепозиторийИзображения -> (структура)

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

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

ИдентификаторИзображения -> (строка)

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

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

КонфигурацияИзображения -> (структура)

Конфигурация для запуска идентифицированного изображения.

ПеременныеСредыВыполнения -> (карта)

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

ключ -> (строка)

значение -> (строка)

КомандаЗапуска -> (строка)

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

Порт -> (строка)

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

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

СекретыСредыВыполнения -> (карта)

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

Примечание

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

ключ -> (строка)

значение -> (строка)

ТипРепозиторияИзображения -> (строка)

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

АвтоматическиеРазвертыванияВключены -> (булево)

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

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

КонфигурацияАвторизации -> (структура)

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

ConnectionArn -> (строка)

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

AccessRoleArn -> (строка)

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

КонфигурацияИнстансов -> (структура)

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

Cpu -> (строка)

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

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

Память -> (строка)

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

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

InstanceRoleArn -> (строка)

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

КонфигурацияШифрования -> (структура)

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

KmsKey -> (строка)

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

КонфигурацияПроверкиСостояния -> (структура)

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

Protocol -> (строка)

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

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

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

Path -> (строка)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

AutoScalingConfigurationArn -> (строка)

Amazon Resource Name (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 Resource Name (ARN) соединителя VPC App Runner, который вы хотите связать со своей службой App Runner. Действительно только когда EgressType = VPC.

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

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

IsPubliclyAccessible -> (логическое значение)

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

IpAddressType -> (строка)

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

Примечание

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

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

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

ObservabilityEnabled -> (логическое значение)

Когда true, ресурс конфигурации наблюдаемости связан со службой, и указана ObservabilityConfigurationArn.

ObservabilityConfigurationArn -> (строка)

Amazon Resource Name (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