create-event-subscription
Описание
Создает подписку на уведомления о событиях RDS. Для этой операции требуется тема Amazon Resource Name (ARN), созданная с помощью консоли RDS, консоли SNS или API SNS. Чтобы получить ARN с помощью SNS, необходимо создать тему в Amazon SNS и подписаться на нее. ARN отображается в консоли SNS.
Вы можете указать тип источника (SourceType ), о событиях которого вы хотите получать уведомления, и предоставить список источников RDS (SourceIds ), которые запускают события. Вы также можете предоставить список категорий событий (EventCategories ), о событиях которых вы хотите получать уведомления. Например, вы можете указать SourceType = db-instance , SourceIds = mydbinstance1 , mydbinstance2 и EventCategories = Availability , Backup .
Если вы укажете как тип источника (SourceType ), так и категории событий (SourceIds ), например, SourceType = db-instance и SourceIds = myDBInstance1 , вы будете получать уведомления обо всех событиях (db-instance ) для указанного источника. Если вы укажете тип источника (SourceType ), но не укажете категории событий (SourceIds ), вы получите уведомления о событиях для этого типа источника для всех ваших источников RDS. Если вы не укажете ни тип источника, ни категории событий (SourceIds ), вы получите уведомления о событиях, сгенерированных всеми источниками RDS, принадлежащими вашей учетной записи.
Дополнительную информацию о подписке на событие для баз данных RDS см. в руководстве пользователя Amazon RDS .
Дополнительную информацию о подписке на событие для баз данных Aurora см. в руководстве пользователя Amazon Aurora.
См. также: Документация 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, созданной для уведомлений о событиях. SNS автоматически создает ARN при создании темы и подписке на нее.
Примечание
RDS не поддерживает темы FIFO (первый вошел, первый вышел). Дополнительную информацию см. в руководстве разработчика Amazon Simple Notification Service.--source-type (строка)
Тип источника, генерирующего события. Например, если вы хотите получать уведомления о событиях, генерируемых экземпляром базы данных, установите этот параметр в db-instance . Для событий RDS Proxy укажите db-proxy . Если этот параметр не указан, возвращаются все события.
Допустимые значения:db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-deployment
--event-categories (список)
Список категорий событий для определенного типа источника (SourceType ), на которые вы хотите подписаться. Список категорий для данного типа источника можно найти в разделе «Категории событий Amazon RDS и сообщения об событиях» в руководстве пользователя Amazon RDS или в руководстве пользователя Amazon Aurora. Этот список также можно получить, используя операцию DescribeEventCategories.
(строка)
Синтаксис:
"string" "string" ...
--source-ids (список)
Список идентификаторов источников событий, для которых возвращаются события. Если не указан, то во всех ответах будут включены все источники. Идентификатор должен начинаться с буквы и содержать только ASCII буквы, цифры и дефисы. Он не может оканчиваться дефисом или содержать два последовательных дефиса.
Ограничения:
- Если указаны
SourceIds, то должны быть указаны иSourceType. - Если тип источника — экземпляр базы данных, необходимо указать значение
DBInstanceIdentifier. - Если тип источника — кластер базы данных, необходимо указать значение
DBClusterIdentifier. - Если тип источника — группа параметров базы данных, необходимо указать значение
DBParameterGroupName. - Если тип источника — группа безопасности базы данных, необходимо указать значение
DBSecurityGroupName. - Если тип источника — снимок базы данных, необходимо указать значение
DBSnapshotIdentifier. - Если тип источника — снимок кластера базы данных, необходимо указать значение
DBClusterSnapshotIdentifier. - Если тип источника — RDS Proxy, необходимо указать значение
DBProxyName.
(строка)
Синтаксис:
"string" "string" ...
--enabled | --no-enabled (логическое значение)
--tags (список)
Список тегов.
Дополнительную информацию см. в руководстве пользователя Amazon RDS или руководстве пользователя Amazon Aurora.
(структура)
Метаданные, назначенные ресурсу Amazon RDS, представляющие собой пару ключ-значение.
Дополнительную информацию см. в руководстве пользователя Amazon RDS или руководстве пользователя Amazon Aurora.
Ключ -> (строка)
aws: или rds: . Строка может содержать только символы Юникода, цифры, пробелы, «_», «.», «:», «/», «=», «+», «-», «@» (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).Значение -> (строка)
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
- 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.
Для создания подписки на события
Следующий create-event-subscription пример создает подписку на события резервного копирования и восстановления для экземпляров баз данных в текущей учетной записи AWS. Уведомления отправляются на тему Amazon Simple Notification Service, указанную --sns-topic-arn.
aws rds create-event-subscription \
--subscription-name my-instance-events \
--source-type db-instance \
--event-categories '["backup","recovery"]' \
--sns-topic-arn arn:aws:sns:us-east-1:123456789012:interesting-events
Вывод:
{
"EventSubscription": {
"Status": "creating",
"CustSubscriptionId": "my-instance-events",
"SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018",
"EventCategoriesList": [
"backup",
"recovery"
],
"SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events",
"CustomerAwsId": "123456789012",
"EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events",
"SourceType": "db-instance",
"Enabled": true
}
}
Вывод
EventSubscription -> (структура)
Содержит результаты успешного вызова действия DescribeEventSubscriptions.
CustomerAwsId -> (строка)
CustSubscriptionId -> (строка)
SnsTopicArn -> (строка)
Status -> (строка)
Статус подписки на уведомления об событиях RDS.
Ограничения:
Может быть одним из следующих: creating | modifying | deleting | active | no-permission | topic-not-exist
Статус «no-permission» указывает, что у RDS больше нет разрешения на отправку сообщений в тему SNS. Статус «topic-not-exist» указывает, что тема была удалена после создания подписки.
SubscriptionCreationTime -> (строка)
SourceType -> (строка)
SourceIdsList -> (список)
Список идентификаторов источников для подписки на уведомления об событиях RDS.
(строка)
EventCategoriesList -> (список)
Список категорий событий для подписки на уведомления об событиях RDS.
(строка)
Enabled -> (булево)
EventSubscriptionArn -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.