создать-журнал
Описание
Создаёт новый журнал в вашем аккаунте Amazon Web Services в текущем регионе.
См. также: Документацию API AWS
Синтаксис
create-ledger
--name <value>
[--tags <value>]
--permissions-mode <value>
[--deletion-protection | --no-deletion-protection]
[--kms-key <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 (строка)
Имя журнала, который вы хотите создать. Имя должно быть уникальным среди всех журналов в вашем аккаунте Amazon Web Services в текущем регионе.
Ограничения именования журналов определены в разделе квоты в Amazon QLDB в руководстве разработчика Amazon QLDB.
--tags (массив)
Ключево-значительные пары, которые необходимо добавить в качестве тегов к журналу, который вы хотите создать. Ключи тегов чувствительны к регистру. Значения тегов чувствительны к регистру и могут быть null.
ключ -> (строка)
значение -> (строка)
Сокращённый синтаксис:
KeyName1=string,KeyName2=string
Синтаксис JSON:
{"string": "string"
...}
--permissions-mode (строка)
Режим разрешений, который необходимо назначить журналу, который вы хотите создать. Этот параметр может принимать одно из следующих значений:
-
ALLOW_ALL: устаревший режим разрешений, который позволяет управлять доступом с детализацией на уровне API для журналов. Этот режим позволяет пользователям, обладающим правом доступаSendCommandAPI для данного журнала, выполнять все команды PartiQL (следовательно,ALLOW_ALL) над любыми таблицами в указанном журнале. Этот режим игнорирует любые политики IAM на уровне таблицы или команды, которые вы создаёте для журнала. -
STANDARD: (Рекомендуется) режим разрешений, который позволяет более тонко управлять доступом для журналов, таблиц и команд PartiQL. По умолчанию этот режим отклоняет все запросы пользователей на выполнение любых команд PartiQL над любыми таблицами в этом журнале. Чтобы разрешить выполнение команд PartiQL, необходимо создать политики IAM для определённых ресурсов таблиц и действий PartiQL, помимо разрешения доступаSendCommandAPI для журнала. Подробнее см. Начало работы со стандартным режимом разрешений в руководстве разработчика Amazon QLDB.
Примечание
Сильно рекомендуем использовать режим разрешенийSTANDARD для максимальной защиты данных вашего журнала.Возможные значения:
ALLOW_ALLSTANDARD
--deletion-protection | --no-deletion-protection (логическое значение)
Указывает, защищён ли журнал от удаления любым пользователем. Если не определено при создании журнала, эта функция включена (true) по умолчанию.
Если защита от удаления включена, её необходимо отключить перед удалением журнала. Для этого вызовите операцию UpdateLedger, чтобы установить этот параметр в значение false.
--kms-key (строка)
Ключ в Key Management Service (KMS), используемый для шифрования данных в состоянии покоя в журнале. Дополнительную информацию см. в разделе Шифрование в состоянии покоя в руководстве разработчика Amazon QLDB.
Используйте один из следующих вариантов для указания этого параметра:
-
AWS_OWNED_KMS_KEY: используйте ключ KMS, который принадлежит и управляется Amazon Web Services от вашего имени. - Не определено : по умолчанию используется ключ KMS, принадлежащий Amazon Web Services.
- Действительный симметричный управляемый клиентом ключ KMS : используйте указанный симметричный шифровальный ключ KMS в вашем аккаунте, который вы создали, владеете и управляете. Amazon QLDB не поддерживает асимметричные ключи. Дополнительную информацию см. в разделе Использование симметричных и асимметричных ключей в руководстве разработчика Key Management Service.
Для указания управляемого клиентом ключа KMS можно использовать его идентификатор ключа, имя ресурса Amazon (ARN), псевдоним или ARN псевдонима. При использовании имени псевдонима предваряйте его "alias/". Для указания ключа в другом аккаунте Amazon Web Services необходимо использовать ARN ключа или ARN псевдонима.
Например:
- Идентификатор ключа:
1234abcd-12ab-34cd-56ef-1234567890ab - ARN ключа:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - Имя псевдонима:
alias/ExampleAlias - ARN псевдонима:
arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
Дополнительную информацию см. в разделе Идентификаторы ключей (KeyId) в руководстве разработчика Key Management Service.
--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: Создание журнала с параметрами по умолчанию
Следующий пример создаёт журнал с именем myExampleLedger и режимом разрешений STANDARD. Не указанные необязательные параметры для защиты от удаления и ключа AWS KMS принимают значения по умолчанию: true и ключ KMS, принадлежащий AWS соответственно.
aws qldb create-ledger \
--name myExampleLedger \
--permissions-mode STANDARD
Вывод:
{
"State": "CREATING",
"Arn": "arn:aws:qldb:us-west-2:123456789012:ledger/myExampleLedger",
"DeletionProtection": true,
"CreationDateTime": 1568839243.951,
"Name": "myExampleLedger",
"PermissionsMode": "STANDARD"
}
Пример 2: Создание журнала с отключённой защитой от удаления, управляемым клиентом ключом KMS и указанными тегами
Следующий пример создаёт журнал с именем myExampleLedger2 и режимом разрешений STANDARD. Функция защиты от удаления отключена, для шифрования в состоянии покоя используется указанный управляемый клиентом ключ KMS, а к ресурсу прикреплены указанные теги.
aws qldb create-ledger \
--name myExampleLedger2 \
--permissions-mode STANDARD \
--no-deletion-protection \
--kms-key arn:aws:kms:us-west-2:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \
--tags IsTest=true,Domain=Test
Вывод:
{
"Arn": "arn:aws:qldb:us-west-2:123456789012:ledger/myExampleLedger2",
"DeletionProtection": false,
"CreationDateTime": 1568839543.557,
"State": "CREATING",
"Name": "myExampleLedger2",
"PermissionsMode": "STANDARD",
"KmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}
Дополнительную информацию см. в разделе Основные операции для журналов Amazon QLDB в руководстве разработчика Amazon QLDB.
Вывод
Имя -> (строка)
Arn -> (строка)
Состояние -> (строка)
CreationDateTime -> (отметка времени)
PermissionsMode -> (строка)
DeletionProtection -> (булево)
Указывает, защищена ли книга от удаления любым пользователем. Если параметр не определен при создании книги, по умолчанию эта функция включена (true).
Если защита от удаления включена, перед удалением книги необходимо сначала отключить ее. Для этого можно вызвать операцию UpdateLedger, чтобы установить этот параметр в значение false.
KmsKeyArn -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.