Spec-Zone.ru › AWS CLI v2

[ aws . appfabric ]

создание-назначения-поглощения

Описание

Создаёт назначение поглощения, которое определяет, как данные, поглощаемые приложением, обрабатываются Amazon Web Services AppFabric и куда они доставляются.

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

Синтаксис

  create-ingestion-destination
--app-bundle-identifier <value>
--ingestion-identifier <value>
--processing-configuration <value>
--destination-configuration <value>
[--client-token <value>]
[--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]

Параметры

--app-bundle-identifier (строка)

Amazon Resource Name (ARN) или универсальный уникальный идентификатор (UUID) пакета приложения, который нужно использовать для запроса.

--ingestion-identifier (строка)

Amazon Resource Name (ARN) или универсальный уникальный идентификатор (UUID) поглощения, которое нужно использовать для запроса.

--processing-configuration (структура помеченного объединения)

Содержит сведения о том, как обрабатываются поглощённые данные.

Примечание

Это структура помеченного объединения. Можно задать только один из следующих ключевых элементов верхнего уровня: auditLog.

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

Содержит сведения о конфигурации обработки журнала аудита.

schema -> (строка)

Схема событий, в которой должны быть отформатированы журналы аудита.

format -> (строка)

Формат, в котором должны быть отформатированы журналы аудита.

Краткая форма синтаксиса:

auditLog={schema=string,format=string}

Синтаксис JSON:

{
  "auditLog": {
    "schema": "ocsf"|"raw",
    "format": "json"|"parquet"
  }
}

--destination-configuration (структура помеченного объединения)

Содержит сведения о назначении поглощённых данных.

Примечание

Это структура помеченного объединения. Можно задать только один из следующих ключевых элементов верхнего уровня: auditLog.

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

Содержит сведения о конфигурации назначения журнала аудита.

destination -> (структура помеченного объединения)

Содержит сведения о назначении журнала аудита.

Примечание

Это структура помеченного объединения. Можно задать только один из следующих ключевых элементов верхнего уровня: s3Bucket, firehoseStream.

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

Содержит сведения об Amazon S3-бакете.

bucketName -> (строка)

Название Amazon S3-бакета.

prefix -> (строка)

Используемый ключ объекта.

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

Содержит сведения о потоке доставки Amazon Kinesis Data Firehose.

streamName -> (строка)

Название потока доставки Amazon Kinesis Data Firehose.

Синтаксис JSON:

{
  "auditLog": {
    "destination": {
      "s3Bucket": {
        "bucketName": "string",
        "prefix": "string"
      },
      "firehoseStream": {
        "streamName": "string"
      }
    }
  }
}

--client-token (строка)

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

Если вы не предоставите это значение, Amazon Web Services сгенерирует случайное.

Если вы повторно выполните операцию с тем же ClientToken, но с другими параметрами, повторная попытка завершится ошибкой IdempotentParameterMismatch.

--tags (список)

Карта пар ключ-значение тега или тегов, которые нужно назначить ресурсу.

(структура)

Ключ или ключи пар ключ-значение для тега или тегов, назначенных ресурсу.

key -> (строка)

Ключ тега.

value -> (строка)

Значение тега.

Краткая форма синтаксиса:

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. Если предоставлено значение null или строка 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 (булево)

Отключить вывод AWS CLI pager.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

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

Содержит сведения о назначении поглощения.

arn -> (строка)

Amazon Resource Name (ARN) назначения поглощения.

ingestionArn -> (строка)

Amazon Resource Name (ARN) поглощения.

processingConfiguration -> (структура помеченного объединения)

Содержит сведения о том, как обрабатываются поглощённые данные.

Примечание

Это структура помеченного объединения. Можно задать только один из следующих ключевых элементов верхнего уровня: auditLog.

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

Содержит сведения о конфигурации обработки журнала аудита.

schema -> (строка)

Схема событий, в которой должны быть отформатированы журналы аудита.

format -> (строка)

Формат, в котором должны быть отформатированы журналы аудита.

destinationConfiguration -> (структура помеченного объединения)

Содержит сведения о назначении поглощённых данных.

Примечание

Это структура помеченного объединения. Можно задать только один из следующих ключевых элементов верхнего уровня: auditLog.

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

Содержит сведения о конфигурации назначения журнала аудита.

destination -> (структура помеченного объединения)

Содержит сведения о назначении журнала аудита.

Примечание

Это структура помеченного объединения. Можно задать только один из следующих ключевых элементов верхнего уровня: s3Bucket, firehoseStream.

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

Содержит сведения об Amazon S3-бакете.

bucketName -> (строка)

Название Amazon S3-бакета.

prefix -> (строка)

Используемый ключ объекта.

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

Содержит сведения о потоке доставки Amazon Kinesis Data Firehose.

streamName -> (строка)

Название потока доставки Amazon Kinesis Data Firehose.

status -> (строка)

Состояние назначения поглощения.

Возможны следующие состояния:

  • Active : Назначение поглощения активно и готово к использованию.
  • Failed : Назначение поглощения завершилось ошибкой. Если назначение поглощения находится в этом состоянии, проверьте конфигурацию назначения поглощения и повторите попытку.

statusReason -> (строка)

Причина текущего состояния назначения поглощения.

Присутствует только тогда, когда status назначения поглощения является Failed.

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

Метка времени создания назначения поглощения.

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

Метка времени последнего обновления назначения поглощения.

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

Spec-Zone.ru

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