Spec-Zone.ru › AWS CLI v2

[ aws . rds ]

изменить-базу-данных-арендатора

Описание

Изменяет существующую базу данных арендатора в экземпляре БД. Вы можете изменить имя базы данных арендатора или пароль пользователя master. Эта операция поддерживается только для экземпляров RDS for Oracle CDB с использованием многоарендаторной конфигурации.

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

Синтаксис

  modify-tenant-database
--db-instance-identifier <value>
--tenant-db-name <value>
[--master-user-password <value>]
[--new-tenant-db-name <value>]
[--manage-master-user-password | --no-manage-master-user-password]
[--rotate-master-user-password | --no-rotate-master-user-password]
[--master-user-secret-kms-key-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]

Параметры

--db-instance-identifier (строка)

Идентификатор экземпляра БД, содержащего базу данных арендатора, которую вы изменяете. Этот параметр не чувствителен к регистру.

Ограничения:

  • Должен соответствовать идентификатору существующего экземпляра БД.

--tenant-db-name (строка)

Имя базы данных арендатора, предоставленное пользователем, которую вы хотите изменить. Этот параметр не чувствителен к регистру.

Ограничения:

  • Должен соответствовать идентификатору существующей базы данных арендатора.

--master-user-password (строка)

Новый пароль для пользователя master указанной базы данных арендатора в вашем экземпляре БД.

Примечание

Операции Amazon RDS никогда не возвращают пароль, поэтому это действие предоставляет способ повторного доступа к пользователю базы данных арендатора, если пароль утерян. Это включает восстановление привилегий, которые могли быть случайно отозваны.

Ограничения:

  • Может содержать любые печатные символы ASCII, кроме / , " (двойная кавычка), @ , & (амперсанд) и ' (одинарная кавычка).

Ограничения по длине:

  • Длина должна быть от 8 до 30 символов.

--new-tenant-db-name (строка)

Новое имя базы данных арендатора при переименовании базы данных арендатора. Этот параметр не чувствителен к регистру.

Ограничения:

  • Не может быть строкой null или любым другим зарезервированным словом.
  • Не может быть длиннее 8 символов.

--manage-master-user-password | --no-manage-master-user-password (логическое значение)

Указывает, нужно ли управлять паролем пользователя master с помощью Amazon Web Services Secrets Manager.

Если база данных арендатора не управляет паролем пользователя master с помощью Amazon Web Services Secrets Manager, вы можете включить это управление. В этом случае вы не можете указать MasterUserPassword .

Если база данных арендатора уже управляет паролем пользователя master с помощью Amazon Web Services Secrets Manager, и вы указываете, что пароль пользователя master не управляется с помощью Amazon Web Services Secrets Manager, тогда вы должны указать MasterUserPassword . В этом случае Amazon RDS удаляет секрет и использует новый пароль для пользователя master, указанный в MasterUserPassword .

Для получения дополнительной информации см. Управление паролями с помощью Amazon Web Services Secrets Manager в Руководстве пользователя Amazon RDS.

Ограничения:

  • Нельзя управлять паролем пользователя master с помощью Amazon Web Services Secrets Manager, если указан MasterUserPassword .

--rotate-master-user-password | --no-rotate-master-user-password (логическое значение)

Указывает, нужно ли вращать секрет, управляемый Amazon Web Services Secrets Manager, для пароля пользователя master.

Это значение имеет смысл только если пароль пользователя master управляется RDS в Amazon Web Services Secrets Manager для экземпляра БД. Значение секрета содержит обновлённый пароль.

Для получения дополнительной информации см. Управление паролями с помощью Amazon Web Services Secrets Manager в Руководстве пользователя Amazon RDS.

Ограничения:

  • При вращении пароля пользователя master необходимо применить изменения немедленно.

--master-user-secret-kms-key-id (строка)

Идентификатор ключа Amazon Web Services KMS для шифрования секрета, который автоматически генерируется и управляется в Amazon Web Services Secrets Manager.

Это значение имеет смысл только если оба следующих условия выполнены:

  • База данных арендатора не управляет паролем пользователя master в Amazon Web Services Secrets Manager. Если база данных арендатора уже управляет паролем пользователя master в Amazon Web Services Secrets Manager, вы не можете изменить ключ KMS, используемый для шифрования секрета.
  • Вы включаете ManageMasterUserPassword для управления паролем пользователя master в Amazon Web Services Secrets Manager. Если вы включаете ManageMasterUserPassword и не указываете MasterUserSecretKmsKeyId , то для шифрования секрета используется ключ KMS aws/secretsmanager . Если секрет находится в другом аккаунте Amazon Web Services, то вы не можете использовать ключ KMS aws/secretsmanager для шифрования секрета и должны использовать самоуправляемый ключ KMS.

Идентификатор ключа Amazon Web Services KMS может быть одним из следующих:

  • ARN ключа
  • Идентификатор ключа
  • ARN псевдонима
  • Имя псевдонима для ключа KMS

Для использования ключа KMS в другом аккаунте Amazon Web Services укажите ARN ключа или ARN псевдонима.

Для вашего аккаунта Amazon Web Services существует ключ KMS по умолчанию. У вашего аккаунта Amazon Web Services есть разные ключи KMS по умолчанию для каждой зоны Amazon Web Services.

--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-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

TenantDatabase -> (структура)

База данных арендатора в экземпляре БД. Этот тип данных является элементом ответа на действие DescribeTenantDatabases.

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

Время создания базы данных арендатора.

DBInstanceIdentifier -> (строка)

Идентификатор экземпляра БД, содержащего базу данных арендатора.

TenantDBName -> (строка)

Имя базы данных базы данных арендатора.

Status -> (строка)

Состояние базы данных арендатора.

MasterUsername -> (строка)

Имя пользователя мастера базы данных арендатора.

DbiResourceId -> (строка)

Уникальный, неизменяемый идентификатор экземпляра БД, относящийся к определённой Региону Amazon Web Services.

TenantDatabaseResourceId -> (строка)

Уникальный, неизменяемый идентификатор базы данных арендатора, относящийся к определённой Региону Amazon Web Services.

TenantDatabaseARN -> (строка)

Идентификатор ресурса Amazon (ARN) базы данных арендатора.

CharacterSetName -> (строка)

Набор символов базы данных арендатора.

NcharCharacterSetName -> (строка)

Наименование набора символов NCHAR базы данных арендатора.

DeletionProtection -> (логическое значение)

Указывает, включена ли защита от удаления для экземпляра БД.

PendingModifiedValues -> (структура)

Информация о предстоящих изменениях для базы данных арендатора.

MasterUserPassword -> (строка)

Пароль пользователя мастера базы данных арендатора.

TenantDBName -> (строка)

Имя базы данных арендатора.

MasterUserSecret -> (структура)

Содержит секрет, управляемый RDS в Amazon Web Services Secrets Manager для пароля пользователя мастера.

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

SecretArn -> (строка)

Идентификатор ресурса Amazon (ARN) секрета.

SecretStatus -> (строка)

Состояние секрета.

Возможные значения состояния включают:

  • creating - Секрет создается.
  • active - Секрет доступен для обычного использования и обновления.
  • rotating - Секрет обновляется.
  • impaired - Секрет можно использовать для доступа к учетным данным базы данных, но его нельзя обновить. Секрет может иметь такое состояние, если, например, изменены разрешения, поэтому RDS больше не может получить доступ к секрету или ключу KMS для секрета. Если секрет имеет это состояние, можно исправить ситуацию, которая привела к этому состоянию. Или же можно изменить экземпляр БД, чтобы отключить автоматическое управление учетными данными базы данных, а затем снова изменить экземпляр БД, чтобы включить автоматическое управление учетными данными базы данных.

KmsKeyId -> (строка)

Идентификатор ключа KMS Amazon Web Services, используемого для шифрования секрета.

TagList -> (список)

Список тегов.

Дополнительную информацию см. в разделе Тегирование ресурсов Amazon RDS в руководстве пользователя Amazon RDS или в разделе Тегирование ресурсов Amazon Aurora и Amazon RDS в руководстве пользователя Amazon Aurora.

(структура)

Метаданные, назначенные ресурсу Amazon RDS, представляющие собой пару «ключ-значение».

Дополнительную информацию см. в разделе Тегирование ресурсов Amazon RDS в руководстве пользователя Amazon RDS или в разделе Тегирование ресурсов Amazon Aurora и Amazon RDS в руководстве пользователя Amazon Aurora.

Key -> (строка)

Ключ — это требуемое имя тега. Строковое значение может содержать от 1 до 128 символов Юникода, оно не может начинаться с aws: или rds:. Строка может содержать только набор символов Юникода, цифры, пробелы, «_», «.», «:», «/», «=», «+», «-», «@» (регулярное выражение Java: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

Value -> (строка)

Значение — это необязательное значение тега. Строковое значение может содержать от 1 до 256 символов Юникода, оно не может начинаться с aws: или rds:. Строка может содержать только набор символов Юникода, цифры, пробелы, «_», «.», «:», «/», «=», «+», «-», «@» (регулярное выражение Java: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

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

Spec-Zone.ru

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