Spec-Zone.ru › AWS CLI v2

[ aws . neptune ]

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

Описание

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

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

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

См. также: Документация 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 SNS (ARN) темы, созданной для уведомлений о событиях. ARN создаётся Amazon SNS при создании темы и подписке на неё.

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

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

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

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

Список категорий событий для SourceType, на которые вы хотите подписаться. Список категорий для данного SourceType можно просмотреть, используя действие DescribeEventCategories.

(строка)

Синтаксис:

"string" "string" ...

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

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

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

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

(строка)

Синтаксис:

"string" "string" ...

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

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

--tags (список)

Теги, которые будут применены к новой подписке на события.

(структура)

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

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

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

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

Значение — это необязательное значение тега. Строковое значение может содержать от 1 до 256 символов Юникода и не может начинаться с aws: или rds: . Строка может содержать только набор символов Юникода, цифр, пробелов, «_», «.», «/», «=», «+», «-» (регулярное выражение Java: “^([\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
  • текст
  • таблица
  • 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-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

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

Содержит результаты успешного вызова действия DescribeEventSubscriptions.

CustomerAwsId -> (строка)

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

CustSubscriptionId -> (строка)

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

SnsTopicArn -> (строка)

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

Status -> (строка)

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

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

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

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

SubscriptionCreationTime -> (строка)

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

SourceType -> (строка)

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

SourceIdsList -> (список)

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

(строка)

EventCategoriesList -> (список)

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

(строка)

Enabled -> (булево)

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

EventSubscriptionArn -> (строка)

Идентификатор ресурса Amazon (ARN) для подписки на события.

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

Spec-Zone.ru

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