Spec-Zone.ru › AWS CLI v2

[ aws . dms ]

create-event-subscription

Описание

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

Вы можете указать тип источника (SourceType ), о событиях которого хотите быть уведомлены, предоставить список идентификаторов источников DMS (SourceIds ), которые запускают события, и предоставить список категорий событий (EventCategories ), о которых хотите получать уведомления. Если вы укажете и SourceType , и SourceIds , такие как SourceType = replication-instance и SourceIdentifier = my-replinstance , вы будете получать уведомления обо всех событиях экземпляра репликации для указанного источника. Если вы укажете SourceType, но не укажете SourceIdentifier , вы получите уведомления о событиях для этого типа источника для всех ваших источников DMS. Если вы не укажете ни SourceType, ни SourceIdentifier , вы будете получать уведомления о событиях, сгенерированных всеми источниками DMS, принадлежащими вашему учётной записи.

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

См. также: Документацию 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 (строка)

Имя подписки на уведомления о событиях DMS. Это имя должно быть меньше 255 символов.

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

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

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

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

Допустимые значения: replication-instance | replication-task

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

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

(строка)

Синтаксис:

"string" "string" ...

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

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

Если значение не указано, уведомления предоставляются для всех источников.

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

(строка)

Синтаксис:

"string" "string" ...

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

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

--tags (список)

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

(структура)

Пользовательская пара ключ-значение, описывающая метаданные, добавленные к ресурсу DMS, которые используются в таких операциях, как:

  • AddTagsToResource
  • ListTagsForResource
  • RemoveTagsFromResource

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

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

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

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

ResourceArn -> (строка)

Строка Amazon Resource Name (ARN), которая уникально идентифицирует ресурс, для которого создаётся тег.

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

Key=string,Value=string,ResourceArn=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string",
    "ResourceArn": "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.

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

Следующий create-event-subscription пример создаёт подписку на уведомления о событиях в теме Amazon SNS (my-sns-topic).

aws dms create-event-subscription \
    --subscription-name my-dms-events \
    --sns-topic-arn arn:aws:sns:us-east-1:123456789012:my-sns-topic

Вывод:

{
    "EventSubscription": {
        "CustomerAwsId": "123456789012",
        "CustSubscriptionId": "my-dms-events",
        "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:my-sns-topic",
        "Status": "creating",
        "SubscriptionCreationTime": "2020-05-21 21:58:38.598",
        "Enabled": true
    }
}

Для получения дополнительной информации см. раздел Работа с событиями и уведомлениями в Руководстве пользователя службы миграции баз данных AWS.

Вывод

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

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

CustomerAwsId -> (строка)

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

CustSubscriptionId -> (строка)

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

SnsTopicArn -> (строка)

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

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

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

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

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

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

SubscriptionCreationTime -> (строка)

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

SourceType -> (строка)

Тип ресурса DMS, генерирующего события.

Допустимые значения: replication-instance | replication-server | security-group | replication-task

SourceIdsList -> (список)

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

(строка)

EventCategoriesList -> (список)

Список категорий событий.

(строка)

Enabled -> (булево)

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

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

Spec-Zone.ru

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