rotate-secret

Описание

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

При успешном вращении метка стадии AWSPENDING может быть прикреплена к той же версии, что и версия AWSCURRENT, или она может быть не прикреплена ни к одной версии. Если метка стадии AWSPENDING присутствует, но не прикреплена к той же версии, что и версия AWSCURRENT, то любое последующее выполнение RotateSecret предполагает, что предыдущий запрос на вращение всё ещё в процессе и возвращает ошибку. При неудачном вращении метка стадии AWSPENDING может быть прикреплена к пустой версии секрета. Дополнительные сведения см. в разделе Устранение неполадок при вращении в руководстве пользователя Secrets Manager.

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

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

Синтаксис

  rotate-secret
--secret-id <value>
[--client-request-token <value>]
[--rotation-lambda-arn <value>]
[--rotation-rules <value>]
[--rotate-immediately | --no-rotate-immediately]
[--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 (строка)

--client-request-token (строка)

--rotation-lambda-arn (строка)

--rotation-rules (структура)

Синтаксис сокращённой записи:

AutomaticallyAfterDays=long,Duration=string,ScheduleExpression=string

Синтаксис JSON:

{
  "AutomaticallyAfterDays": long,
  "Duration": "string",
  "ScheduleExpression": "string"
}

--rotate-immediately | --no-rotate-immediately (булево)

--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 (boolean)

Включить отладочную запись в журнал.

--endpoint-url (string)

Переопределить стандартный URL команды заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с сервисами AWS. Для каждого SSL-соединения AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет стандартное поведение проверки сертификатов SSL.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команд.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

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

--profile (string)

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

--region (string)

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

--version (string)

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

--color (string)

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

• on
• off
• auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.

--ca-bundle (string)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат 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 (boolean)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (boolean)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматический запрос параметров ввода CLI.

Примеры

Пример 1: Настройка и запуск автоматической ротации секрета

В следующем rotate-secret примере настраивается и запускается автоматическая ротация секрета. Secrets Manager производит ротацию секрета один раз сразу, а затем каждые восемь часов в течение двухчасового интервала. Вывод показывает VersionId новой версии секрета, созданной в результате ротации.

aws secretsmanager rotate-secret \
    --secret-id MyTestDatabaseSecret \
    --rotation-lambda-arn arn:aws:lambda:us-west-2:1234566789012:function:SecretsManagerTestRotationLambda \
    --rotation-rules "{\"ScheduleExpression\": \"cron(0 8/8 * * ? *)\", \"Duration\": \"2h\"}"

Вывод:

{
    "ARN": "aws:arn:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
    "Name": "MyTestDatabaseSecret",
    "VersionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}

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

Пример 2: Настройка и запуск автоматической ротации по интервалу

В следующем rotate-secret примере настраивается и запускается автоматическая ротация секрета. Secrets Manager производит ротацию секрета один раз сразу, а затем каждые 10 дней. Вывод показывает VersionId новой версии секрета, созданной в результате ротации.

aws secretsmanager rotate-secret \
    --secret-id MyTestDatabaseSecret \
    --rotation-lambda-arn arn:aws:lambda:us-west-2:1234566789012:function:SecretsManagerTestRotationLambda \
    --rotation-rules "{\"ScheduleExpression\": \"rate(10 days)\"}"

Вывод:

{
    "ARN": "aws:arn:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
    "Name": "MyTestDatabaseSecret",
    "VersionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}

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

Пример 3: Ротация секрета немедленно

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

aws secretsmanager rotate-secret \
    --secret-id MyTestDatabaseSecret

Вывод:

{
    "ARN": "aws:arn:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
    "Name": "MyTestDatabaseSecret",
    "VersionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}

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

Вывод

ARN -> (строка)

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

VersionId -> (строка)