изменение-основного-региона
Описание
Изменяет основной ключ многорегионального ключа.
Данная операция изменяет ключ-реплику в указанном регионе на основной ключ и изменяет предыдущий основной ключ на ключ-реплику. Например, предположим, что у вас есть основной ключ в us-east-1 и ключ-реплика в eu-west-2. Если вы выполните UpdatePrimaryRegion со значением PrimaryRegion равным eu-west-2, то основной ключ теперь будет ключом в eu-west-2, а ключ в us-east-1 станет ключом-репликой. Подробнее см. Обновление основного региона в Руководстве разработчика службы управления ключами.
Данная операция поддерживает многорегиональные ключи, функцию KMS, которая позволяет создавать несколько взаимозаменяемых ключей KMS в различных регионах Amazon Web Services. Поскольку эти ключи KMS имеют одинаковый идентификатор ключа, материал ключа и другие метаданные, вы можете использовать их взаимозаменяемо для шифрования данных в одном регионе Amazon Web Services и расшифровки их в другом регионе Amazon Web Services без повторного шифрования данных или выполнения вызова между регионами. Более подробную информацию о многорегиональных ключах см. в разделе Многорегиональные ключи в KMS в Руководстве разработчика службы управления ключами.
Основной ключ многорегионального ключа является источником свойств, которые всегда общие для основных и реплицированных ключей, включая материал ключа, идентификатор ключа, спецификацию ключа, использование ключа, происхождение материала ключа и автоматическое обновление ключа. Это единственный ключ, который может быть реплицирован. Вы не можете удалить основной ключ, пока не будут удалены все ключи-реплики.
Идентификатор ключа и основной регион, которые вы указываете, однозначно идентифицируют ключ-реплику, который станет основным ключом. В основном регионе должен уже быть ключ-реплика. Данная операция не создает ключ KMS в указанном регионе. Чтобы найти ключи-реплики, используйте операцию DescribeKey для основного ключа или любого ключа-реплики. Чтобы создать ключ-реплику, используйте операцию ReplicateKey.
Вы можете выполнить эту операцию, используя затронутые многорегиональные ключи в криптографических операциях. Эта операция не должна задерживать, прерывать или вызывать сбои в криптографических операциях.
Даже после завершения этой операции процесс обновления основного региона может еще продолжаться несколько секунд. Такие операции, как DescribeKey, могут отображать как старый, так и новый основные ключи как реплики. Старый и новый основные ключи имеют временное состояние ключа Updating. Исходное состояние ключа восстанавливается при завершении обновления. Пока состояние ключа Updating, вы можете использовать ключи в криптографических операциях, но вы не можете реплицировать новый основной ключ или выполнять определенные операции управления, такие как включение или выключение этих ключей. Более подробную информацию о состоянии ключа Updating см. в разделе Состояния ключей ключей KMS в Руководстве разработчика службы управления ключами.
Данная операция не возвращает никаких результатов. Чтобы проверить, что основной ключ изменен, используйте операцию DescribeKey.
Использование в разных учетных записях: Нет. Вы не можете использовать эту операцию в другой учетной записи Amazon Web Services.
Необходимые разрешения:
-
kms:UpdatePrimaryRegionдля текущего основного ключа (в регионе основного ключа). Включите это разрешение в политике ключа основного ключа. -
kms:UpdatePrimaryRegionдля текущего ключа-реплики (в регионе ключа-реплики). Включите это разрешение в политике ключа ключа-реплики.
- CreateKey
- ReplicateKey
См. также: Документация API AWS
Синопсис
update-primary-region
--key-id <value>
--primary-region <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]
Параметры
--key-id (строка)
Идентифицирует текущий первичный ключ. После завершения операции этот ключ KMS будет являться ключом-репликой.
Укажите идентификатор ключа или ARN ключа первичного ключа в нескольких регионах.
Например:
- Идентификатор ключа:
mrk-1234abcd12ab34cd56ef1234567890ab - ARN ключа:
arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab
Чтобы получить идентификатор и ARN ключа KMS, используйте ListKeys или DescribeKey .
--primary-region (строка)
Регион Amazon Web Services для нового первичного ключа. Введите идентификатор региона, например, us-east-1 или ap-southeast-2 . В этом регионе должен существовать существующий ключ-реплика.
После завершения операции ключ в нескольких регионах в этом регионе станет первичным ключом.
--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-auto-prompt (булево)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (булево)
Отключить автоматическое запросы параметров ввода CLI.
Вывод
Нет
© Copyright 2025, Amazon Web Services. Created using Sphinx.