[ aws . secretsmanager ]
удаление-регионов-из-репликации
Описание
Для секрета, который реплицируется в другие регионы, удаляет копии секрета из указанных вами регионов.
Secrets Manager генерирует запись в журнале CloudTrail при вызове этого действия. Не включайте конфиденциальную информацию в параметры запроса, так как она может быть залогирована. Для получения дополнительной информации, см. Логирование событий Secrets Manager с помощью CloudTrail .
secretsmanager:RemoveRegionsFromReplication . Для получения дополнительной информации, см. Действия политики IAM для Secrets Manager и Авторизация и контроль доступа в Secrets Manager .См. также: Документация API AWS
Синтаксис
remove-regions-from-replication
--secret-id <value>
--remove-replica-regions <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]
Параметры
--secret-id (строка)
--remove-replica-regions (список)
Регионы реплик, которые нужно удалить.
(строка)
Синтаксис:
"string" "string" ...
--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.
Для удаления секрета-копии
Следующий remove-regions-from-replication пример удаляет копию секрета в регионе eu-west-3. Чтобы удалить основной секрет, который реплицируется в другие регионы, сначала удалите копии, а затем вызовите delete-secret.
aws secretsmanager remove-regions-from-replication \
--secret-id MyTestSecret \
--remove-replica-regions eu-west-3
Вывод:
{
"ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-1a2b3c",
"ReplicationStatus": []
}
Для получения дополнительной информации, см. Удаление копии секрета в руководстве пользователя Secrets Manager.
Вывод
Уникальный идентификатор (ARN) -> (строка)
СтатусРепликации -> (список)
Статус реплик для данного секрета после удаления регионов.
(структура)
Объект репликации, состоящий из объекта RegionReplicationStatus и включающий регион, KMSKeyId, статус и сообщение статуса.
Регион -> (строка)
KmsKeyId -> (строка)
ARN , Key ID или Alias.Статус -> (строка)
InProgress , Failed или InSync.СообщениеСтатуса -> (строка)
ДатаПоследнегоДоступа -> (метка времени)
© Copyright 2025, Amazon Web Services. Created using Sphinx.