Spec-Zone.ru › AWS CLI v2

[ aws . sns ]

создать-тему

Описание

Создаёт тему, к которой можно публиковать уведомления. Пользователи могут создать не более 100 000 стандартных тем (не более 1000 тем FIFO). Для получения дополнительной информации см. Создание темы Amazon SNS в руководстве для разработчиков Amazon SNS . Данное действие является идемпотентным, поэтому если запрашивающий уже владеет темой с указанным именем, возвращается ARN этой темы без создания новой темы.

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

Синтаксис

  create-topic
--name <value>
[--attributes <value>]
[--tags <value>]
[--data-protection-policy <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]

Параметры

--name (строка)

Имя темы, которую вы хотите создать.

Ограничения: Имена тем должны состоять только из прописных и строчных ASCII букв, цифр, нижних подчеркиваний и дефисов и должны иметь длину от 1 до 256 символов.

Для темы FIFO (first-in-first-out) имя должно оканчиваться на .fifo суффикс.

--attributes (массив)

Массив атрибутов со значениями.

Ниже приведены имена, описания и значения специальных параметров запроса, которые использует действие CreateTopic:

  • DeliveryPolicy – Политика, определяющая, как Amazon SNS повторно пытается выполнить неудачные доставки в HTTP/S-точки входа.
  • DisplayName – Имя для отображения, используемое для темы с SMS-подписками.
  • FifoTopic – Устанавливается в значение true для создания темы FIFO.
  • Policy – Политика, определяющая, кто может получить доступ к вашей теме. По умолчанию только владелец темы может публиковать или подписываться на тему.
  • SignatureVersion – Версия подписи соответствует алгоритму хеширования, используемому при создании подписи уведомлений, подтверждений подписки или подтверждений отписки, отправленных Amazon SNS. По умолчанию SignatureVersion устанавливается в 1 .
  • TracingConfig – Режим отслеживания темы Amazon SNS. По умолчанию TracingConfig устанавливается в PassThrough , и тема передаёт заголовок отслеживания, полученный от издателя Amazon SNS, своим подпискам. Если установлено Active , Amazon SNS передаст данные сегмента X-Ray владельцу учетной записи темы, если флаг выборки в заголовке отслеживания имеет значение true. Это поддерживается только для стандартных тем.

Следующий атрибут применим только к шифрованию на стороне сервера:

  • KmsMasterKeyId – Идентификатор управляемого Amazon Web Services ключа шифрования на стороне клиента (CMK) для Amazon SNS или пользовательского CMK. Для получения дополнительной информации см. Определения терминов . Для получения дополнительных примеров см. KeyId в справочнике API службы управления ключами .

Следующие атрибуты применяются только к темам FIFO:

  • ArchivePolicy – Политика, которая задаёт срок хранения сообщений, хранящихся в архиве сообщений темы Amazon SNS FIFO.
  • ContentBasedDeduplication – Включает дублирование на основе содержимого для тем FIFO.
    • По умолчанию ContentBasedDeduplication устанавливается в false . Если вы создаёте тему FIFO, и этот атрибут имеет значение false , вы должны указать значение для параметра MessageDeduplicationId для действия Publish.
    • Когда вы устанавливаете ContentBasedDeduplication в значение true , Amazon SNS использует хэш SHA-256 для генерации MessageDeduplicationId на основе тела сообщения (но не атрибутов сообщения). (Необязательно) Чтобы переопределить сгенерированное значение, вы можете указать значение для параметра MessageDeduplicationId для действия Publish.
  • FifoThroughputScope – Включает более высокую пропускную способность для вашей темы FIFO, изменяя область дублирования. Этот атрибут имеет два возможных значения:
    • Topic – Область дублирования сообщений охватывает всю тему. Это значение по умолчанию и сохраняет существующее поведение с максимальной пропускной способностью 3000 сообщений в секунду или 20 МБ в секунду, что произойдёт раньше.
    • MessageGroup – Область дублирования находится внутри каждой отдельной группы сообщений, что обеспечивает более высокую пропускную способность на тему, ограниченную региональными квотами. Для получения дополнительной информации о квотах или для запроса увеличения см. Квоты службы Amazon SNS в общем справочнике Amazon Web Services.

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

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

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--tags (список)

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

Примечание

Чтобы иметь возможность добавлять теги к теме при её создании, вам должны быть предоставлены права sns:CreateTopic и sns:TagResource.

(структура)

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

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

Обязательная часть ключа тега.

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

Необязательная часть значения тега.

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

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--data-protection-policy (строка)

Тело документа политики, который вы хотите использовать для этой темы.

Вы можете добавить только одну политику на тему.

Политика должна быть в формате JSON-строки.

Ограничения длины: Максимальная длина 30 720.

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

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

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

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

Примеры

Примечание

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

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

Создание темы SNS

Следующий create-topic пример создаёт тему SNS с именем my-topic.

aws sns create-topic \
    --name my-topic

Вывод:

{
    "ResponseMetadata": {
        "RequestId": "1469e8d7-1642-564e-b85d-a19b4b341f83"
    },
    "TopicArn": "arn:aws:sns:us-west-2:123456789012:my-topic"
}

Дополнительную информацию см. в разделе Использование командной строки AWS с Amazon SQS и Amazon SNS в руководстве пользователя командной строки AWS.

Вывод

TopicArn -> (строка)

Amazon Resource Name (ARN), назначенный созданной теме.

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

Spec-Zone.ru

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