delete-secret

Описание

Удаляет секрет и все его версии. Вы можете указать период восстановления, в течение которого вы можете восстановить секрет. Минимальный период восстановления составляет 7 дней. По умолчанию период восстановления составляет 30 дней. Secrets Manager добавляет отметку DeletionDate к секрету, которая указывает конец периода восстановления. По истечении периода восстановления Secrets Manager удаляет секрет окончательно.

Вы не можете удалить основной секрет, который реплицирован в другие регионы. Сначала необходимо удалить реплики, используя RemoveRegionsFromReplication, а затем удалить основной секрет. При удалении реплики она удаляется немедленно.

Вы не можете напрямую удалить версию секрета. Вместо этого, удалите все метки этапов подготовки из версии, используя UpdateSecretVersionStage. Это помечает версию как устаревшую, и тогда Secrets Manager может автоматически удалить версию в фоновом режиме.

Чтобы определить, использует ли приложение секрет, вы можете создать Amazon CloudWatch сигнал, который будет оповещать вас об любых попытках доступа к секрету в период восстановления. Дополнительная информация приведена в разделе Monitor secrets scheduled for deletion.

Secrets Manager выполняет постоянное удаление секрета по истечении периода ожидания как фоновую задачу с низким приоритетом. Нет гарантии конкретного времени после периода восстановления для выполнения окончательного удаления.

В любое время до окончания периода восстановления вы можете использовать RestoreSecret, чтобы удалить DeletionDate и отменить удаление секрета.

Когда секрет запланирован на удаление, вы не можете получить значение секрета. Сначала необходимо отменить удаление с помощью RestoreSecret, а затем вы можете получить секрет.

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

См. также: AWS API Documentation

Синтаксис

  delete-secret
--secret-id <value>
[--recovery-window-in-days <value>]
[--force-delete-without-recovery | --no-force-delete-without-recovery]
[--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 (строка)

--recovery-window-in-days (целое число)

--force-delete-without-recovery | --no-force-delete-without-recovery (логическое значение)

--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
• таблица
• 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.

Примеры

Пример 1: Удаление секрета

Следующий delete-secret пример удаляет секрет. Вы можете восстановить секрет с помощью restore-secret до даты и времени в поле DeletionDate ответа. Чтобы удалить секрет, реплицированный в другие регионы, сначала удалите его реплики с помощью remove-regions-from-replication, а затем вызовите delete-secret.

aws secretsmanager delete-secret \
    --secret-id MyTestSecret \
    --recovery-window-in-days 7

Вывод:

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

Дополнительную информацию см. в разделе Удаление секрета в руководстве пользователя Secrets Manager.

Пример 2: Немедленное удаление секрета

Следующий delete-secret пример удаляет секрет немедленно без периода восстановления. Этот секрет невозможно восстановить.

aws secretsmanager delete-secret \
    --secret-id MyTestSecret \
    --force-delete-without-recovery

Вывод:

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

Дополнительную информацию см. в разделе Удаление секрета в руководстве пользователя Secrets Manager.

Вывод

ARN -> (строка)

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

DeletionDate -> (метка времени)