Spec-Zone.ru › AWS CLI v2

[ aws . redshift ]

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

Описание

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

Можно указать тип источника и список идентификаторов источников Amazon Redshift, категорий событий и уровней серьёзности событий. Уведомления будут отправляться для всех событий, соответствующих указанным критериям. Например, можно указать тип источника = кластер, идентификатор источника = my-cluster-1 и mycluster2, категории событий = Доступность, Бэкап, и уровень серьёзности = ОШИБКА. Подписка будет отправлять уведомления только для событий ОШИБКА в категориях Доступность и Бэкап для указанных кластеров.

Если указать тип источника и идентификаторы источников, например, тип источника = кластер и идентификатор источника = my-cluster-1, уведомления будут отправляться для всех событий кластера для my-cluster-1. Если указать тип источника, но не указать идентификатор источника, вы получите уведомления о событиях для объектов этого типа в вашей учётной записи Amazon Web Services. Если не указать ни тип источника, ни идентификатор источника, вы будете уведомлены о событиях, сгенерированных всеми источниками Amazon Redshift, принадлежащими вашей учётной записи Amazon Web Services. Необходимо указать тип источника, если вы указываете идентификатор источника.

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

Синтаксис

  create-event-subscription
--subscription-name <value>
--sns-topic-arn <value>
[--source-type <value>]
[--source-ids <value>]
[--event-categories <value>]
[--severity <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 (строка)

Имя создаваемой подписки на события.

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

  • Не может быть пустым или содержать только пробелы.
  • Должно содержать от 1 до 255 буквенно-цифровых символов или дефисов.
  • Первый символ должен быть буквой.
  • Не может заканчиваться дефисом или содержать два дефиса подряд.

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

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

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

Тип источника, который будет генерировать события. Например, если вы хотите получать уведомления о событиях, генерируемых кластером, установите этот параметр в значение cluster. Если этот параметр не указан, события возвращаются для всех объектов Amazon Redshift в вашей учётной записи Amazon Web Services. Необходимо указать тип источника для указания идентификаторов источников.

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

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

Список одного или нескольких идентификаторов объектов источников Amazon Redshift. Все объекты должны быть одного типа, как и тип источника, указанный в параметре типа источника. Подписка на события будет возвращать только события, сгенерированные указанными объектами. Если не указано, то события возвращаются для всех объектов внутри указанного типа источника.

Пример: my-cluster-1, my-cluster-2

Пример: my-snapshot-20131010

(строка)

Синтаксис:

"string" "string" ...

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

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

Значения: configuration, management, monitoring, security, pending

(строка)

Синтаксис:

"string" "string" ...

--severity (строка)

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

Значения: ERROR, INFO

--enabled | --no-enabled (логическое значение)

Логическое значение; установите в true для активации подписки, и установите в false для создания подписки, но без её активации.

--tags (список)

Список пар имя/значение тегов.

(структура)

Тег, состоящий из пары имя/значение для ресурса.

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

Ключ или имя тега ресурса.

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

Значение тега ресурса.

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

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-auto-prompt (логическое значение)

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

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

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

Примеры

Примечание

Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Подробнее см. руководство по началу работы в Руководстве пользователя AWS CLI.

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

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

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

aws redshift create-event-subscription \
    --subscription-name mysubscription \
    --sns-topic-arn arn:aws:sns:us-west-2:123456789012:MySNStopic \
    --source-type cluster \
    --source-ids mycluster

Вывод:

{
        "EventSubscription": {
        "CustomerAwsId": "123456789012",
        "CustSubscriptionId": "mysubscription",
        "SnsTopicArn": "arn:aws:sns:us-west-2:123456789012:MySNStopic",
        "Status": "active",
        "SubscriptionCreationTime": "2019-12-09T20:05:19.365Z",
        "SourceType": "cluster",
        "SourceIdsList": [
            "mycluster"
        ],
        "EventCategoriesList": [],
        "Severity": "INFO",
        "Enabled": true,
        "Tags": []
    }
}

Дополнительную информацию см. в разделе Подписка на уведомления об событиях Amazon Redshift в Руководстве по администрированию кластера Amazon Redshift.

Вывод

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

Описание подписки на события.

CustomerAwsId -> (строка)

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

CustSubscriptionId -> (строка)

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

SnsTopicArn -> (строка)

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

Status -> (строка)

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

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

  • Может принимать одно из следующих значений: active | no-permission | topic-not-exist
  • Статус “no-permission” указывает, что у Amazon Redshift больше нет разрешения публиковать в тему Amazon SNS. Статус “topic-not-exist” указывает, что тема была удалена после создания подписки.

SubscriptionCreationTime -> (метка времени)

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

SourceType -> (строка)

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

SourceIdsList -> (список)

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

(строка)

EventCategoriesList -> (список)

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

Значения: Configuration, Management, Monitoring, Security, Pending

(строка)

Severity -> (строка)

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

Значения: ERROR, INFO

Enabled -> (булево)

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

Tags -> (список)

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

(структура)

Тег, состоящий из пары имя/значение для ресурса.

Key -> (строка)

Ключ или имя тега ресурса.

Value -> (строка)

Значение тега ресурса.

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

Spec-Zone.ru

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