Spec-Zone.ru › AWS CLI v2

[ aws . secretsmanager ]

cancel-rotate-secret

Описание

Отключает автоматическое вращение и, если вращение в данный момент происходит, отменяет его.

Если вы отменяете текущее вращение, это может привести к тому, что метки VersionStage окажутся в неожиданном состоянии. Возможно, потребуется удалить метку этапа подготовки AWSPENDING из частично созданной версии. Вам также необходимо определить, нужно ли откатиться к предыдущей версии секрета, перенеся метку этапа подготовки AWSCURRENT на версию, имеющую AWSPENDING . Чтобы определить, какая версия имеет конкретную метку этапа подготовки, вызовите ListSecretVersionIds. Затем используйте UpdateSecretVersionStage для изменения меток этапа подготовки. Для получения дополнительной информации см. Как работает вращение .

Чтобы снова включить автоматическое вращение, вызовите RotateSecret.

Secrets Manager генерирует запись журнала CloudTrail при вызове этого действия. Не включайте конфиденциальную информацию в параметры запроса, так как она может быть записана в журнал. Дополнительные сведения см. в разделе Ведение журналов событий Secrets Manager с помощью CloudTrail .

Необходимые разрешения: secretsmanager:CancelRotateSecret . Дополнительные сведения см. в разделе Действия политики IAM для Secrets Manager и Аутентификация и управление доступом в Secrets Manager .

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

Синтаксис

  cancel-rotate-secret
--secret-id <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 (строка)

ARN или имя секрета.

Для ARN рекомендуется указывать полный ARN, а не частичный. См. Нахождение секрета по частичному ARN .

--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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включение/отключение цветного вывода.

  • on
  • off
  • auto

--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 в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей консоли. См. Использование кавычек со строками в Руководстве пользователя AWS CLI .

Чтобы отключить автоматическое вращение для секрета

Следующий cancel-rotate-secret пример отключает автоматическое вращение для секрета. Чтобы возобновить вращение, вызовите rotate-secret.

aws secretsmanager cancel-rotate-secret \
    --secret-id MyTestSecret

Вывод:

{
  "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-a1b2c3",
  "Name": "MyTestSecret"
}

Дополнительные сведения см. в разделе Вращение секрета в Руководстве пользователя Secrets Manager.

Вывод

ARN -> (строка)

ARN секрета.

Имя -> (строка)

Имя секрета.

VersionId -> (строка)

Уникальный идентификатор версии секрета, созданной во время вращения. Эта версия может быть неполной и должна быть проверена на возможность удаления. Рекомендуется удалить значение VersionStage AWSPENDING из этой версии, чтобы Secrets Manager мог удалить ее. Невыполнение очистки отмененного вращения может помешать вам начать будущие вращения.

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

Spec-Zone.ru

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