Spec-Zone.ru › AWS CLI v2

[ aws . synthetics ]

update-canary

Описание

Обновляет конфигурацию канэри, который уже был создан.

Вы не можете использовать эту операцию для обновления тегов существующего канэри. Чтобы изменить теги существующего канэри, используйте TagResource .

Примечание

При использовании поля dryRunId при обновлении канэри, единственное другое поле, которое вы можете предоставить, это Schedule. Добавление любого другого поля вызовет исключение.

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

Синтаксис

  update-canary
--name <value>
[--code <value>]
[--execution-role-arn <value>]
[--runtime-version <value>]
[--schedule <value>]
[--run-config <value>]
[--success-retention-period-in-days <value>]
[--failure-retention-period-in-days <value>]
[--vpc-config <value>]
[--visual-reference <value>]
[--artifact-s3-location <value>]
[--artifact-config <value>]
[--provisioned-resource-cleanup <value>]
[--dry-run-id <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]

Параметры

--name (строка)

Имя канарейки, которую вы хотите обновить. Чтобы найти имена своих канареек, используйте DescribeCanaries .

Вы не можете изменить имя канарейки, которая уже была создана.

--code (структура)

Структура, которая включает точку входа, с которой канарейка должна начать выполнение вашего скрипта. Если скрипт хранится в ведре S3, также указаны имя ведра, ключ и версия.

S3Bucket -> (строка)

Если ваш скрипт канарейки находится в S3, укажите здесь имя ведра. Не включайте s3:// в качестве начала имени ведра.

S3Key -> (строка)

Ключ S3 вашего скрипта. Для получения дополнительной информации см. Работа с объектами Amazon S3 .

S3Version -> (строка)

Идентификатор версии S3 вашего скрипта.

ZipFile -> (бинарный файл)

Если вы вводите скрипт канарейки непосредственно в канарейку вместо ссылки на расположение в S3, значение этого параметра — это содержимое сжатого файла .zip, содержащего скрипт, закодированное в base64. Оно должно быть меньше 225 Кб.

Для больших скриптов канареек мы рекомендуем использовать расположение в S3 вместо ввода его напрямую с помощью этого параметра.

Handler -> (строка)

Точка входа для использования исходного кода при запуске канарейки. Для канареек, использующих syn-python-selenium-1.0 или syn-nodejs.puppeteer runtime версии ранее syn-nodejs.puppeteer-3.4 , обработчик должен быть указан как `` имяФайла .handler`` . Для syn-python-selenium-1.1 , syn-nodejs.puppeteer-3.4 и более поздних версий runtime обработчик можно указать как `` имяФайла .*имяФункции* ``, или вы можете указать папку, где находятся скрипты канарейки, как `` папка /имяФайла .*имяФункции* ``.

Сокращенная синтаксис:

S3Bucket=string,S3Key=string,S3Version=string,ZipFile=blob,Handler=string

Синтаксис JSON:

{
  "S3Bucket": "string",
  "S3Key": "string",
  "S3Version": "string",
  "ZipFile": blob,
  "Handler": "string"
}

--execution-role-arn (строка)

ARN роли IAM, которая будет использоваться для запуска канарейки. Эта роль должна уже существовать и должна включать lambda.amazonaws.com в качестве принципала в политике доверия. Роль также должна иметь следующие разрешения:

  • s3:PutObject
  • s3:GetBucketLocation
  • s3:ListAllMyBuckets
  • cloudwatch:PutMetricData
  • logs:CreateLogGroup
  • logs:CreateLogStream
  • logs:CreateLogStream

--runtime-version (строка)

Указывает версию runtime, которая будет использоваться для канарейки. Список допустимых версий runtime и дополнительная информация о версиях runtime приведены в Canary Runtime Versions .

--schedule (структура)

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

Expression -> (строка)

Выражение rate или выражение cron, определяющее частоту выполнения канарейки.

Для выражения скорости синтаксис выглядит следующим образом: rate(*number unit* ) . единица может быть minute , minutes или hour .

Например, rate(1 minute) запускает канарейку один раз в минуту, rate(10 minutes) — один раз каждые 10 минут, а rate(1 hour) — один раз в час. Вы можете указать частоту от rate(1 minute) до rate(1 hour) .

Указание rate(0 minute) или rate(0 hour) — специальное значение, которое заставляет канарейку запуститься только один раз при запуске.

Используйте cron(*expression* ) для указания выражения cron. Вы не можете запланировать канарейку на ожидание более года перед запуском. Дополнительную информацию о синтаксисе выражений cron см. в разделе Планирование запусков канареек с помощью cron .

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

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

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

Структура, содержащая настройки повторных попыток для канарейки

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

Максимальное число повторных попыток. Значение должно быть меньше или равно 2.

Сокращенная синтаксис:

Expression=string,DurationInSeconds=long,RetryConfig={MaxRetries=integer}

Синтаксис JSON:

{
  "Expression": "string",
  "DurationInSeconds": long,
  "RetryConfig": {
    "MaxRetries": integer
  }
}

--run-config (структура)

Структура, содержащая значение таймаута, используемое для каждого отдельного запуска канарейки.

Предупреждение

Ключи и значения переменных среды шифруются в состоянии покоя с использованием KMS-ключей, принадлежащих Amazon Web Services. Однако переменные среды не шифруются на стороне клиента. Не храните конфиденциальную информацию в них.

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

Сколько времени канарейке разрешено работать, прежде чем она должна остановиться. Вы не можете установить это время больше, чем частота запусков этой канарейки.

Если этот параметр опущен, частота канарейки используется как это значение, до максимального значения 14 минут.

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

Максимальное количество памяти, доступное канарейке во время работы в МБ. Это значение должно быть кратным 64.

ActiveTracing -> (булево)

Указывает, будет ли эта канарейка использовать активное отслеживание X-Ray при запуске. Активное отслеживание позволяет отображать этот запуск канарейки в картах ServiceLens и X-Ray, даже если канарейка не обращается к конечной точке с включенным отслеживанием X-Ray. Использование отслеживания X-Ray влечёт расходы. Для получения дополнительной информации см. Канарейки и отслеживание X-Ray .

Вы можете включить активное отслеживание только для канареек, использующих версию syn-nodejs-2.0 или более позднюю версию для их runtime канарейки.

EnvironmentVariables -> (словарь)

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

{ “ключ1” : “значение1”, “ключ2” : “значение2”, …}

Ключи должны начинаться с буквы и иметь не менее двух символов. Общий размер ваших переменных окружения не может превышать 4 КБ. Вы не можете указать любые зарезервированные переменные среды Lambda в качестве ключей для ваших переменных окружения. Для получения дополнительной информации о зарезервированных ключах см. Переменные среды runtime .

Предупреждение

Ключи и значения переменных среды шифруются в состоянии покоя с использованием KMS-ключей, принадлежащих Amazon Web Services. Однако переменные среды не шифруются на стороне клиента. Не храните конфиденциальную информацию в них.

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

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

Сокращенная синтаксис:

TimeoutInSeconds=integer,MemoryInMB=integer,ActiveTracing=boolean,EnvironmentVariables={KeyName1=string,KeyName2=string}

Синтаксис JSON:

{
  "TimeoutInSeconds": integer,
  "MemoryInMB": integer,
  "ActiveTracing": true|false,
  "EnvironmentVariables": {"string": "string"
    ...}
}

--success-retention-period-in-days (целое число)

Количество дней хранения данных об успешных запусках этой канарейки.

Это значение влияет на диапазон информации, возвращаемой GetCanaryRuns, а также на диапазон информации, отображаемой в консоли Synthetics.

--failure-retention-period-in-days (целое число)

Количество дней хранения данных об ошибочных запусках этой канарейки.

Это значение влияет на диапазон информации, возвращаемой GetCanaryRuns, а также на диапазон информации, отображаемой в консоли Synthetics.

--vpc-config (структура)

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

SubnetIds -> (список)

Идентификаторы подсетей, в которых должна работать эта канарейка.

(строка)

SecurityGroupIds -> (список)

Идентификаторы групп безопасности для этой канарейки.

(строка)

Ipv6AllowedForDualStack -> (булево)

Установите это в true , чтобы разрешить исходящий IPv6-трафик в канарейках VPC, подключенных к подсетям с двойной стековой поддержкой. Значение по умолчанию — false

Сокращенная синтаксис:

SubnetIds=string,string,SecurityGroupIds=string,string,Ipv6AllowedForDualStack=boolean

Синтаксис JSON:

{
  "SubnetIds": ["string", ...],
  "SecurityGroupIds": ["string", ...],
  "Ipv6AllowedForDualStack": true|false
}

--visual-reference (структура)

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

Визуальный мониторинг поддерживается только в канарейках, использующих UpdateCanary runtime или более поздние версии. Дополнительную информацию см. в Visual monitoring и Visual monitoring blueprint

BaseScreenshots -> (список)

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

(структура)

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

ScreenshotName -> (строка)

Имя скриншота. Оно генерируется в первый раз, когда канарейка запускается после операции UpdateCanary, которая указана для этой канарейки для выполнения визуального мониторинга.

IgnoreCoordinates -> (список)

Координаты, определяющие часть экрана, которую следует игнорировать при сравнении скриншотов. Чтобы получить координаты для использования здесь, используйте консоль CloudWatch для определения границ на экране. Дополнительную информацию см. в разделе Редактирование или удаление канарейки

(строка)

BaseCanaryRunId -> (строка)

Указывает, запуск какой канарейки использовать в качестве эталона для будущего визуального мониторинга с этой канарейкой. Допустимые значения — nextrun, чтобы использовать скриншоты из следующего запуска после внесения этого обновления; lastrun, чтобы использовать скриншоты из последнего запуска перед внесением этого обновления; или значение Id в CanaryRun из запуска этой канарейки в течение последних 31 дня. Если вы укажете Id запуска канарейки старше 31 дня, операция вернёт ошибку проверки 400.

Синтаксис JSON:

{
  "BaseScreenshots": [
    {
      "ScreenshotName": "string",
      "IgnoreCoordinates": ["string", ...]
    }
    ...
  ],
  "BaseCanaryRunId": "string"
}

--artifact-s3-location (строка)

Расположение в Amazon S3, где Synthetics хранит артефакты из тестовых запусков этой канарейки. Артефакты включают файл журнала, скриншоты и файлы HAR. Имя ведра S3 не может включать точку (.).

--artifact-config (структура)

Структура, содержащая конфигурацию для артефактов canary, включая параметры шифрования артефактов, которые canary загружает в Amazon S3.

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

Структура, содержащая конфигурацию параметров шифрования артефактов, которые canary загружает в Amazon S3. Функциональность шифрования артефактов доступна только для canary, использующих версию среды выполнения Synthetics syn-nodejs-puppeteer-3.3 или более позднюю. Дополнительную информацию см. в разделе Шифрование артефактов canary

EncryptionMode -> (строка)

Метод шифрования, который следует использовать для артефактов, созданных этим canary. Укажите SSE_S3, чтобы использовать шифрование на стороне сервера (SSE) с ключом, управляемым Amazon S3. Укажите SSE-KMS, чтобы использовать шифрование на стороне сервера с управляемым пользователем ключом KMS.

Если этот параметр опущен, используется управляемый Amazon Web Services ключ KMS.

KmsKeyArn -> (строка)

Идентификатор ресурса (ARN) управляемого пользователем ключа KMS, который следует использовать, если вы указали SSE-KMS для EncryptionMode

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

S3Encryption={EncryptionMode=string,KmsKeyArn=string}

Синтаксис JSON:

{
  "S3Encryption": {
    "EncryptionMode": "SSE_S3"|"SSE_KMS",
    "KmsKeyArn": "string"
  }
}

--provisioned-resource-cleanup (строка)

Указывает, следует ли также удалять функции и слои Lambda, используемые этим canary, при удалении canary.

Если значение этого параметра равно OFF, то значение параметра DeleteLambda операции DeleteCanary определяет, будут ли удалены функции и слои Lambda.

Возможные значения:

  • AUTOMATIC
  • OFF

--dry-run-id (строка)

Обновляет существующий canary с использованием обновленных конфигураций из DryRun, связанного с DryRunId.

Примечание

При использовании поля dryRunId при обновлении canary, единственным другим полем, которое вы можете предоставить, является Schedule. Добавление любого другого поля приведет к ошибке.

--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 V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, отображаемого в двоичный блок, fileb:// всегда будет обрабатываться как двоичный и использовать содержимое файла непосредственно, независимо от параметра cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного параметра cli-binary-format.

  • base64
  • raw-in-base64-out

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

Отключить кли-пейджер для вывода.

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

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

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

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

Примеры

Примечание

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

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

Для обновления canary

В следующем update-canary примере обновляется конфигурация canary с именем demo_canary.

aws synthetics update-canary \
    --name demo_canary \
    --schedule Expression="rate(15 minutes)"

Эта команда не производит вывод.

Дополнительную информацию см. в разделе Синтетическое мониторинг (canary) в руководстве пользователя Amazon CloudWatch.

Вывод

Нет

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

Spec-Zone.ru

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