associate-kms-key

Описание

Связывает указанный ключ KMS с одним журналом группы в аккаунте или со всеми сохраненными результатами запросов CloudWatch Logs в аккаунте.

Когда вы используете AssociateKmsKey, вы указываете либо параметр logGroupName, либо параметр resourceIdentifier. Вы не можете указать оба этих параметра в одной операции.

• Укажите параметр logGroupName, чтобы обеспечить шифрование событий журнала, поступающих в эту группу журналов, с помощью этого ключа. Только события журнала, поступающие после связывания ключа, будут зашифрованы этим ключом. Связывание ключа KMS с группой журналов переписывает любые существующие связи между группой журналов и ключом KMS. После связывания ключа KMS с группой журналов все новые данные для группы журналов будут зашифрованы с помощью ключа KMS. Это связывание сохраняется, пока данные, зашифрованные с помощью ключа KMS, находятся в CloudWatch Logs. Это позволяет CloudWatch Logs расшифровывать эти данные при необходимости. Связывание ключа с группой журналов не приводит к шифрованию результатов запросов этой группы журналов с помощью этого ключа. Чтобы зашифровать результаты запросов с помощью ключа KMS, вы должны использовать операцию AssociateKmsKey с параметром resourceIdentifier, который указывает ресурс query-result.
• Укажите параметр resourceIdentifier с ресурсом query-result, чтобы использовать этот ключ для шифрования сохраненных результатов всех будущих операций StartQuery в аккаунте. Ответ от операции GetQueryResults по-прежнему будет возвращать результаты запроса в открытом виде. Даже если вы не связали ключ со своими результатами запросов, результаты запроса шифруются при хранении, используя стандартный метод CloudWatch Logs. Если вы выполняете запрос из учетной записи мониторинга, которая запрашивает журналы в исходной учетной записи, используется ключ результатов запроса из учетной записи мониторинга, если он есть.

На выполнение этой операции может потребоваться до 5 минут.

Если вы попытаетесь связать ключ KMS с группой журналов, но ключа KMS не существует или ключ KMS отключен, вы получите ошибку InvalidParameterException.

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

Синтаксис

  associate-kms-key
[--log-group-name <value>]
--kms-key-id <value>
[--resource-identifier <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]

Параметры

--log-group-name (строка)

--kms-key-id (строка)

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

--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.

Вывод

Нет