Spec-Zone.ru › AWS CLI v2

[ aws . docdb ]

создание-подписки-на-события

Описание

Создаёт подписку на уведомления о событиях Amazon DocumentDB. Для этого действия требуется тема Amazon Resource Name (ARN), созданная с помощью консоли Amazon DocumentDB, консоли Amazon SNS или API Amazon SNS. Чтобы получить ARN с помощью Amazon SNS, необходимо создать тему в Amazon SNS и подписаться на неё. ARN отображается в консоли Amazon SNS.

Можно указать тип источника (SourceType ), о событиях которого требуется уведомление. Также можно указать список источников Amazon DocumentDB (SourceIds ), которые запускают события, и список категорий событий (EventCategories ), о которых требуется уведомление. Например, можно указать SourceType = db-instance , SourceIds = mydbinstance1, mydbinstance2 и EventCategories = Availability, Backup .

Если указать и тип источника (SourceType ), и список категорий событий (SourceIds ) (например, SourceType = db-instance и SourceIdentifier = myDBInstance1 ), вы будете получать уведомления обо всех событиях (db-instance ) для указанного источника. Если указать тип источника (SourceType ), но не указать список категорий событий (SourceIdentifier ), вы получите уведомления о событиях для этого типа источника для всех ваших источников Amazon DocumentDB. Если не указать ни тип источника (SourceType ), ни список категорий событий (SourceIdentifier ), вы будете получать уведомления обо всех событиях, генерируемых всеми источниками Amazon DocumentDB вашей учётной записи.

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

Синтаксис

  create-event-subscription
--subscription-name <value>
--sns-topic-arn <value>
[--source-type <value>]
[--event-categories <value>]
[--source-ids <value>]
[--enabled | --no-enabled]
[--tags <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]

Параметры

--subscription-name (строка)

Имя подписки.

Ограничения: имя должно содержать менее 255 символов.

--sns-topic-arn (строка)

Amazon Resource Name (ARN) темы SNS, созданной для уведомлений о событиях. Amazon SNS создаёт ARN при создании темы и подписке на неё.

--source-type (строка)

Тип источника, генерирующего события. Например, если необходимо получать уведомления о событиях, генерируемых экземпляром, этот параметр следует установить в db-instance . Если этот параметр не указан, возвращаются все события.

Допустимые значения: db-instance , db-cluster , db-parameter-group , db-security-group , db-cluster-snapshot

--event-categories (список)

Список категорий событий для (SourceType ) подписки.

(строка)

Синтаксис:

"string" "string" ...

--source-ids (список)

Список идентификаторов источников событий, для которых возвращаются события. Если не указан, все источники включаются в ответ. Идентификатор должен начинаться с буквы и содержать только ASCII-буквы, цифры и дефисы; не может заканчиваться дефисом или содержать два дефиса подряд.

Ограничения:

  • Если указаны SourceIds , то также должны быть указаны SourceType .
  • Если тип источника — экземпляр, должен быть указан DBInstanceIdentifier .
  • Если тип источника — группа безопасности, должен быть указан DBSecurityGroupName .
  • Если тип источника — группа параметров, должен быть указан DBParameterGroupName .
  • Если тип источника — моментальный снимок, должен быть указан DBSnapshotIdentifier .

(строка)

Синтаксис:

"string" "string" ...

--enabled | --no-enabled (булево)

Булевое значение; установить в true , чтобы активировать подписку, установить в false , чтобы создать подписку, но не активировать её.

--tags (список)

Теги, которые нужно назначить подписке на события.

(структура)

Метаданные, назначенные ресурсу Amazon DocumentDB, представляющие собой пару ключ-значение.

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

Обязательное имя тега. Строковое значение может иметь длину от 1 до 128 символов Юникода и не может начинаться с «aws: » или «rds: ». Строка может содержать только символы Юникода, цифры, пробелы, «_», «.», «/», «=», «+», «-» (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$”).

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

Необязательное значение тега. Строковое значение может иметь длину от 1 до 256 символов Юникода и не может начинаться с «aws: » или «rds: ». Строка может содержать только символы Юникода, цифры, пробелы, «_», «.», «/», «=», «+», «-» (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$”).

Сокращённый синтаксис:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "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
  • text
  • таблица
  • 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.

Вывод

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

Подробная информация о подписке на событие.

CustomerAwsId -> (строка)

Учётная запись Amazon Web Services клиента, связанная с подпиской на уведомления о событиях Amazon DocumentDB.

CustSubscriptionId -> (строка)

Идентификатор подписки на уведомления о событиях Amazon DocumentDB.

SnsTopicArn -> (строка)

ARN темы Amazon DocumentDB для уведомлений о событиях.

Status -> (строка)

Состояние подписки на уведомления о событиях Amazon DocumentDB.

Ограничения:

Может быть одним из следующих: creating , modifying , deleting , active , no-permission , topic-not-exist

Состояние no-permission указывает, что у Amazon DocumentDB больше нет разрешения публиковать в теме SNS. Состояние topic-not-exist указывает, что тема была удалена после создания подписки.

SubscriptionCreationTime -> (строка)

Время создания подписки на уведомления о событиях Amazon DocumentDB.

SourceType -> (строка)

Тип источника для подписки на уведомления о событиях Amazon DocumentDB.

SourceIdsList -> (список)

Список идентификаторов источников для подписки на уведомления о событиях Amazon DocumentDB.

(строка)

EventCategoriesList -> (список)

Список категорий событий для подписки на уведомления о событиях Amazon DocumentDB.

(строка)

Enabled -> (булево)

Булево значение, указывающее, включена ли подписка. Значение true указывает, что подписка включена.

EventSubscriptionArn -> (строка)

Amazon Resource Name (ARN) для подписки на события.

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

Spec-Zone.ru

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