update-secret-version-stage

Описание

Изменяет метки стадии, прикреплённые к версии секрета. Secrets Manager использует метки стадии для отслеживания версии в процессе вращения секрета. Каждая метка стадии может быть прикреплена только к одной версии за раз. Чтобы добавить метку стадии к версии, когда она уже прикреплена к другой версии, Secrets Manager сначала удаляет её с другой версии, а затем прикрепляет её к этой. Для получения дополнительной информации о версиях и метках стадии, см. Концепции: Версия.

Метки стадии, указанные в параметре VersionStage, добавляются к существующему списку меток стадии для версии.

Вы можете переместить метку стадии AWSCURRENT в эту версию, включив её в этот вызов.

Если в результате этого действия последняя метка удаляется из версии, то версия считается устаревшей и может быть удалена Secrets Manager.

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

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

Синтаксис

  update-secret-version-stage
--secret-id <value>
--version-stage <value>
[--remove-from-version-id <value>]
[--move-to-version-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 (строка)

--version-stage (строка)

--remove-from-version-id (строка)

--move-to-version-id (строка)

--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.

Примеры

Пример 1: Восстановление секрета до предыдущей версии

Следующий пример перемещает метку стадии AWSCURRENT в предыдущую версию секрета, что восстанавливает секрет до предыдущей версии. Чтобы найти идентификатор предыдущей версии, используйте list-secret-version-ids. В этом примере версия с меткой AWSCURRENT — a1b2c3d4-5678-90ab-cdef-EXAMPLE11111, а версия с меткой AWSPREVIOUS — a1b2c3d4-5678-90ab-cdef-EXAMPLE22222. В этом примере вы перемещаете метку AWSCURRENT из версии 11111 в 22222. Поскольку метка AWSCURRENT удаляется из версии, update-secret-version-stage автоматически перемещает метку AWSPREVIOUS в эту версию (11111). В результате метки AWSCURRENT и AWSPREVIOUS меняются местами.

aws secretsmanager update-secret-version-stage \
    --secret-id MyTestSecret \
    --version-stage AWSCURRENT \
    --move-to-version-id a1b2c3d4-5678-90ab-cdef-EXAMPLE22222 \
    --remove-from-version-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Вывод:

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

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

Пример 2: Добавление метки стадии, прикреплённой к версии секрета

Следующий пример добавляет метку стадии к версии секрета. Результаты можно проверить, выполнив list-secret-version-ids и просмотрев поле ответа VersionStages для затронутой версии.

aws secretsmanager update-secret-version-stage \
    --secret-id MyTestSecret \
    --version-stage STAGINGLABEL1 \
    --move-to-version-id EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE

Вывод:

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

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

Пример 3: Удаление метки стадии, прикреплённой к версии секрета

Следующий пример удаляет метку стадии, прикреплённую к версии секрета. Результаты можно проверить, выполнив list-secret-version-ids и просмотрев поле ответа VersionStages для затронутой версии.

aws secretsmanager update-secret-version-stage \
    --secret-id MyTestSecret \
    --version-stage STAGINGLABEL1 \
    --remove-from-version-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Вывод:

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

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

Вывод

ARN -> (строка)

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