Spec-Zone.ru › AWS CLI v2

[ aws . iot ]

создать-целевую-точку-правила-темы

Описание

Создаёт целевую точку правила темы. Цель должна быть подтверждена перед использованием.

Требуется разрешение на доступ к действию CreateTopicRuleDestination.

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

Синтаксис

  create-topic-rule-destination
--destination-configuration <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]

Параметры

--destination-configuration (структура)

Настройка целевой точки правила темы.

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

Настройка HTTP-URL.

confirmationUrl -> (строка)

URL, который IoT использует для подтверждения владения или доступа к URL целевой точки правила темы.

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

Настройка подключения виртуальной частной сети (VPC).

subnetIds -> (список)

Идентификаторы подсетей целевой точки VPC.

(строка)

securityGroups -> (список)

Группы безопасности целевой точки VPC.

(строка)

vpcId -> (строка)

Идентификатор VPC.

roleArn -> (строка)

ARN роли, имеющей разрешение на создание и подключение интерфейсов эластичной сети (ENI).

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

httpUrlConfiguration={confirmationUrl=string},vpcConfiguration={subnetIds=[string,string],securityGroups=[string,string],vpcId=string,roleArn=string}

Синтаксис JSON:

{
  "httpUrlConfiguration": {
    "confirmationUrl": "string"
  },
  "vpcConfiguration": {
    "subnetIds": ["string", ...],
    "securityGroups": ["string", ...],
    "vpcId": "string",
    "roleArn": "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-topic-rule-destination пример создаёт целевую точку правила темы для HTTP-точки.

aws iot create-topic-rule-destination \
    --destination-configuration httpUrlConfiguration={confirmationUrl=https://example.com}

Вывод:

{
    "topicRuleDestination": {
        "arn": "arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
        "status": "IN_PROGRESS",
        "statusReason": "Awaiting confirmation. Confirmation message sent on 2020-07-09T22:47:54.154Z; no response received from the endpoint.",
        "httpUrlProperties": {
            "confirmationUrl": "https://example.com"
        }
    }
}

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

Вывод

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

Целевая точка правила темы.

arn -> (строка)

URL целевой точки правила темы.

status -> (строка)

Статус целевой точки правила темы. Допустимые значения:

IN_PROGRESS

Целевая точка правила темы была создана, но ещё не подтверждена. Вы можете установить status на IN_PROGRESS, вызвав UpdateTopicRuleDestination. Вызов UpdateTopicRuleDestination отправляет новый запрос подтверждения на ваш конечный пункт подтверждения.

ENABLED

Подтверждение завершено, и трафик в эту целевую точку разрешён. Вы можете установить status на DISABLED, вызвав UpdateTopicRuleDestination.

DISABLED

Подтверждение завершено, и трафик в эту целевую точку не разрешён. Вы можете установить status на ENABLED, вызвав UpdateTopicRuleDestination.

ERROR

Подтверждение не удалось завершить, например, если подтверждение истекло. Вы можете вызвать GetTopicRuleDestination для получения подробностей об ошибке. Вы можете установить status на IN_PROGRESS, вызвав UpdateTopicRuleDestination. Вызов UpdateTopicRuleDestination отправляет новый запрос подтверждения на ваш конечный пункт подтверждения.

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

Дата и время создания целевой точки правила темы.

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

Дата и время последнего обновления целевой точки правила темы.

statusReason -> (строка)

Дополнительные сведения или причина, по которой целевая точка правила темы находится в текущем состоянии.

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

Свойства HTTP-URL.

confirmationUrl -> (строка)

URL, используемый для подтверждения URL HTTP-целевой точки правила темы.

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

Свойства подключения виртуальной частной сети (VPC).

subnetIds -> (список)

Идентификаторы подсетей целевой точки VPC.

(строка)

securityGroups -> (список)

Группы безопасности целевой точки VPC.

(строка)

vpcId -> (строка)

Идентификатор VPC.

roleArn -> (строка)

ARN роли, имеющей разрешение на создание и подключение интерфейсов эластичной сети (ENI).

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

Spec-Zone.ru

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