Spec-Zone.ru › AWS CLI v2

[ aws . qldb ]

stream-journal-to-kinesis

Описание

Создаёт поток журнала для заданного Amazon QLDB журнала. Поток фиксирует каждую ревизию документа, которая добавляется в журнал журнала, и предоставляет данные указанному ресурсу Amazon Kinesis Data Streams.

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

Синтаксис

  stream-journal-to-kinesis
--ledger-name <value>
--role-arn <value>
[--tags <value>]
--inclusive-start-time <value>
[--exclusive-end-time <value>]
--kinesis-configuration <value>
--stream-name <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]

Параметры

--ledger-name (строка)

Имя журнала.

--role-arn (строка)

Amazon Resource Name (ARN) роли IAM, предоставляющей QLDB разрешения для потока журнала на запись записей данных в ресурс Kinesis Data Streams.

Чтобы передать роль QLDB при запросе потока журнала, необходимо иметь разрешения на выполнение действия iam:PassRole над ресурсом роли IAM. Это требуется для всех запросов потока журнала.

--tags (словарь)

Пары ключ-значение, которые необходимо добавить в качестве тегов к потоку, который вы хотите создать. Ключи тегов чувствительны к регистру. Значения тегов чувствительны к регистру и могут быть null.

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

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

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

--inclusive-start-time (отметка времени)

Включительно начальная дата и время, с которых необходимо начать потоковую передачу данных журнала. Этот параметр должен быть в формате даты и времени ISO 8601 и в формате всемирного координированного времени (UTC). Например: 2019-06-13T21:36:34Z .

InclusiveStartTime не может быть в будущем и должно быть до ExclusiveEndTime .

Если вы предоставите InclusiveStartTime, которое предшествует CreationDateTime журнала, QLDB по умолчанию устанавливает его на CreationDateTime журнала.

--exclusive-end-time (отметка времени)

Исключительная дата и время, которые указывают, когда поток завершается. Если вы не определяете этот параметр, поток работает неопределённо до момента его отмены.

ExclusiveEndTime должен быть в формате даты и времени ISO 8601 и в формате всемирного координированного времени (UTC). Например: 2019-06-13T21:36:34Z .

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

Настройки конфигурации пункта назначения Kinesis Data Streams для запроса потока.

StreamArn -> (строка)

Amazon Resource Name (ARN) ресурса Kinesis Data Streams.

AggregationEnabled -> (логическое значение)

Включает возможность для QLDB публиковать несколько записей данных в одной записи Kinesis Data Streams, увеличивая количество записей, отправляемых за один вызов API.

По умолчанию: True

Предупреждение

Агрегация записей имеет важные последствия для обработки записей и требует деагрегации в вашем потребителе потока. Дополнительные сведения см. в разделах «Основные понятия KPL» и «Деагрегация потребителя» в руководстве разработчика Amazon Kinesis Data Streams.

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

StreamArn=string,AggregationEnabled=boolean

Синтаксис JSON:

{
  "StreamArn": "string",
  "AggregationEnabled": true|false
}

--stream-name (строка)

Имя, которое вы хотите присвоить потоку журнала QLDB. Пользовательские имена могут помочь в идентификации и определении назначения потока.

Имя вашего потока должно быть уникальным среди других *активных* потоков для данного журнала. Имена потоков имеют те же ограничения по именованию, что и имена журналов, как описано в разделе Квоты в Amazon QLDB в руководстве разработчика Amazon QLDB.

--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 в разделе «Использование кавычек со строками».

Пример 1: Потоковая передача данных журнала в Kinesis Data Streams с использованием файлов ввода

В следующем примере создаётся поток данных журнала в заданном диапазоне дат и времени из журнала с именем myExampleLedger. Поток отправляет данные в указанный Amazon Kinesis поток данных.

aws qldb stream-journal-to-kinesis \
    --ledger-name myExampleLedger \
    --inclusive-start-time 2020-05-29T00:00:00Z \
    --exclusive-end-time 2020-05-29T23:59:59Z \
    --role-arn arn:aws:iam::123456789012:role/my-kinesis-stream-role \
    --kinesis-configuration file://my-kinesis-config.json \
    --stream-name myExampleLedger-stream

Содержимое my-kinesis-config.json:

{
    "StreamArn": "arn:aws:kinesis:us-east-1:123456789012:stream/stream-for-qldb",
    "AggregationEnabled": true
}

Вывод:

{
    "StreamId": "7ISCkqwe4y25YyHLzYUFAf"
}

Дополнительные сведения см. в разделе Потоковая передача данных журнала Amazon QLDB в руководстве разработчика Amazon QLDB.

Пример 2: Потоковая передача данных журнала в Kinesis Data Streams с использованием краткого синтаксиса

В следующем примере создаётся поток данных журнала в заданном диапазоне дат и времени из журнала с именем myExampleLedger. Поток отправляет данные в указанный Amazon Kinesis поток данных.

aws qldb stream-journal-to-kinesis \
    --ledger-name myExampleLedger \
    --inclusive-start-time 2020-05-29T00:00:00Z \
    --exclusive-end-time 2020-05-29T23:59:59Z \
    --role-arn arn:aws:iam::123456789012:role/my-kinesis-stream-role \
    --stream-name myExampleLedger-stream \
    --kinesis-configuration StreamArn=arn:aws:kinesis:us-east-1:123456789012:stream/stream-for-qldb,AggregationEnabled=true

Вывод:

{
    "StreamId": "7ISCkqwe4y25YyHLzYUFAf"
}

Дополнительные сведения см. в разделе Потоковая передача данных журнала Amazon QLDB в руководстве разработчика Amazon QLDB.

Вывод

StreamId -> (строка)

Уникальный идентификатор (представленный в текстовом формате Base62), присваиваемый QLDB каждому потоку журнала QLDB.

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

Spec-Zone.ru

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