восстановление-базы-данных-из-снимка

Описание

Создает новую базу данных из снимка базы данных. Целевая база данных создается из исходной точки восстановления с большей частью исходной конфигурации, включая стандартную группу безопасности и группу параметров базы данных. По умолчанию новая база данных создается как развертывание с одиночной зоной доступности, за исключением случаев, когда экземпляр является экземпляром SQL Server, у которого есть группа параметров, связанная с зеркальным отображением. В этом случае экземпляр становится развертыванием с несколькими зонами доступности, а не с одной зоной доступности.

Если вы хотите заменить исходный экземпляр базы данных новым восстановленным экземпляром, переименуйте исходный экземпляр базы данных перед вызовом операции RestoreDBInstanceFromDBSnapshot. RDS не допускает наличие двух экземпляров баз данных с одинаковым именем. После переименования исходного экземпляра базы данных с другим идентификатором вы можете передать исходное имя экземпляра базы данных в качестве DBInstanceIdentifier при вызове операции RestoreDBInstanceFromDBSnapshot. Результатом является замена исходного экземпляра базы данных на экземпляр базы данных, созданный из снимка.

Если вы восстанавливаете из общего ручного снимка базы данных, то DBSnapshotIdentifier должен быть ARN общего снимка базы данных.

Для восстановления из снимка базы данных с недоступной версией движка сначала необходимо обновить версию движка снимка. Для получения дополнительной информации об обновлении версии движка снимка RDS для MySQL см. Обновление версии движка снимка базы данных MySQL. Для получения дополнительной информации об обновлении версии движка снимка RDS для PostgreSQL см. Обновление версии движка снимка базы данных PostgreSQL.

Примечание

Эта команда не применяется к Aurora MySQL и Aurora PostgreSQL. Для Aurora используйте RestoreDBClusterFromSnapshot .

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

Синтаксис

  restore-db-instance-from-db-snapshot
--db-instance-identifier <value>
[--db-snapshot-identifier <value>]
[--db-instance-class <value>]
[--port <value>]
[--availability-zone <value>]
[--db-subnet-group-name <value>]
[--multi-az | --no-multi-az]
[--publicly-accessible | --no-publicly-accessible]
[--auto-minor-version-upgrade | --no-auto-minor-version-upgrade]
[--license-model <value>]
[--db-name <value>]
[--engine <value>]
[--iops <value>]
[--option-group-name <value>]
[--tags <value>]
[--storage-type <value>]
[--tde-credential-arn <value>]
[--tde-credential-password <value>]
[--vpc-security-group-ids <value>]
[--domain <value>]
[--domain-fqdn <value>]
[--domain-ou <value>]
[--domain-auth-secret-arn <value>]
[--domain-dns-ips <value>]
[--copy-tags-to-snapshot | --no-copy-tags-to-snapshot]
[--domain-iam-role-name <value>]
[--enable-iam-database-authentication | --no-enable-iam-database-authentication]
[--enable-cloudwatch-logs-exports <value>]
[--processor-features <value>]
[--use-default-processor-features | --no-use-default-processor-features]
[--db-parameter-group-name <value>]
[--deletion-protection | --no-deletion-protection]
[--enable-customer-owned-ip | --no-enable-customer-owned-ip]
[--custom-iam-instance-profile <value>]
[--backup-target <value>]
[--network-type <value>]
[--storage-throughput <value>]
[--db-cluster-snapshot-identifier <value>]
[--allocated-storage <value>]
[--dedicated-log-volume | --no-dedicated-log-volume]
[--ca-certificate-identifier <value>]
[--engine-lifecycle-support <value>]
[--manage-master-user-password | --no-manage-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 (строка)

Имя экземпляра БД, которое нужно создать из снимка БД. Этот параметр не чувствителен к регистру.

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

Должно содержать от 1 до 63 цифр, букв или дефисов.
Первый символ должен быть буквой.
Не может заканчиваться дефисом или содержать два последовательных дефиса.

Пример: my-snapshot-id

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

Идентификатор снимка БД, из которого нужно выполнить восстановление.

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

Должен соответствовать идентификатору существующего снимка БД.
Не может быть указан, когда указан параметр DBClusterSnapshotIdentifier.
Должен быть указан, когда не указан параметр DBClusterSnapshotIdentifier.
Если вы восстанавливаете из общего ручного снимка БД, DBSnapshotIdentifier должен быть ARN общего снимка БД.

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

Вычислительная и оперативная мощность экземпляра Amazon RDS БД, например db.m4.large. Не все классы экземпляров БД доступны во всех регионах Amazon Web Services или для всех движков баз данных. Полный список классов экземпляров БД и их доступность для вашего движка см. в разделе «Класс экземпляра БД» в Руководстве пользователя Amazon RDS.

По умолчанию: тот же DBInstanceClass, что и у исходного экземпляра БД.

--port (целое число)

Номер порта, на котором база данных принимает подключения.

По умолчанию: тот же порт, что и у исходного экземпляра БД.

Ограничения: значение должно быть 1150-65535

--availability-zone (строка)

Зона доступности (AZ), в которой будет создан экземпляр БД.

По умолчанию: случайная зона доступности, выбранная системой.

Ограничение: параметр AvailabilityZone нельзя указывать, если экземпляр БД является многозонной установкой.

Пример: us-east-1a

--db-subnet-group-name (строка)

Имя группы подсетей БД, которое нужно использовать для нового экземпляра.

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

Если указано, должно соответствовать имени существующей группы подсетей БД.

Пример: mydbsubnetgroup

--multi-az | --no-multi-az (булево)

Указывает, является ли экземпляр БД многозонной установкой.

Это значение не применяется к RDS Custom.

Ограничение: параметр AvailabilityZone нельзя указывать, если экземпляр БД является многозонной установкой.

--publicly-accessible | --no-publicly-accessible (булево)

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

Когда экземпляр БД доступен публично, его DNS-имя разрешается до частного IP-адреса из внутрисетевой виртуальной частной облачной среды (VPC) экземпляра БД. Он разрешается до публичного IP-адреса извне VPC экземпляра БД. Доступ к экземпляру БД в конечном итоге контролируется используемой группой безопасности. Такой публичный доступ запрещён, если назначенная группе безопасности экземпляра БД его не разрешает.

Когда экземпляр БД не доступен публично, это внутренний экземпляр БД с DNS-именем, которое разрешается до частного IP-адреса.

Дополнительную информацию см. в разделе CreateDBInstance.

--auto-minor-version-upgrade | --no-auto-minor-version-upgrade (булево)

Указывает, нужно ли автоматически применять незначительные обновления версий к экземпляру БД во время окна технического обслуживания.

Если вы восстанавливаете экземпляр RDS Custom БД, необходимо отключить этот параметр.

Дополнительную информацию об автоматическом обновлении незначительных версий см. в разделе Автоматическое обновление незначительных версий движка.

--license-model (строка)

Информация о лицензионной модели для восстановленного экземпляра БД.

Примечание

Лицензионные модели для RDS for Db2 требуют дополнительной настройки. Модель «Использование вашей лицензии» (BYOL) требует настройки пользовательской параметрической группы и самостоятельно управляемой лицензии Amazon Web Services License Manager. Модель лицензии Db2 через Amazon Web Services Marketplace требует подписки на Amazon Web Services Marketplace. Дополнительную информацию см. в разделе «Варианты лицензирования Amazon RDS for Db2» в Руководстве пользователя Amazon RDS.

Это значение не применяется к экземплярам Amazon Aurora или RDS Custom БД.

Допустимые значения:

RDS for Db2 - bring-your-own-license | marketplace-license
RDS for MariaDB - general-public-license
RDS for Microsoft SQL Server - license-included
RDS for MySQL - general-public-license
RDS for Oracle - bring-your-own-license | license-included
RDS for PostgreSQL - postgresql-license

По умолчанию: такое же, как у источника.

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

Имя базы данных для восстановленного экземпляра БД.

Этот параметр применяется только к экземплярам RDS for Oracle и RDS for SQL Server БД. Он не применяется к другим движкам или к экземплярам RDS Custom БД.

--engine (строка)

Двигатель базы данных, который нужно использовать для нового экземпляра.

Это значение не применяется к RDS Custom.

По умолчанию: такое же, как у источника.

Ограничение: должно быть совместимо с движком источника. Например, вы можете восстановить экземпляр MariaDB 10.1 БД из снимка MySQL 5.6.

Допустимые значения:

db2-ae
db2-se
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web

--iops (целое число)

Указывает количество выделенных IOPS для экземпляра БД, выраженное в операциях ввода-вывода в секунду. Если этот параметр не указан, значение IOPS берется из резервной копии. Если этот параметр установлен в 0, новый экземпляр преобразуется в экземпляр без PIOPS. Преобразование занимает дополнительное время, но ваш экземпляр БД доступен для подключений до начала преобразования.

Значение выделенных IOPS должно соответствовать требованиям для вашего движка базы данных. Дополнительную информацию см. в разделе «Хранилище Amazon RDS с выделенными IOPS» в Руководстве пользователя Amazon RDS.

Ограничения: должно быть целое число, большее 1000.

--option-group-name (строка)

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

Постоянные параметры, такие как параметр TDE для Oracle Advanced Security TDE, нельзя удалить из группы параметров, и эту группу параметров нельзя удалить из экземпляра БД после ее ассоциации с экземпляром БД.

Это значение не применяется к RDS Custom.

--tags (список)

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

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

(структура)

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

Ключ -> (строка)

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

Значение -> (строка)

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

Сокращенная синтаксическая запись:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--storage-type (строка)

Указывает тип хранилища, который нужно ассоциировать с экземпляром БД.

Допустимые значения: gp2 | gp3 | io1 | io2 | standard

Если вы укажете io1, io2 или gp3, вы также должны указать значение для параметра Iops.

По умолчанию: io1, если указан параметр Iops, в противном случае gp3

--tde-credential-arn (строка)

ARN хранилища ключей, с которым нужно ассоциировать экземпляр для шифрования TDE.

Это значение не применяется к RDS Custom.

--tde-credential-password (строка)

Пароль для данного ARN из хранилища ключей для доступа к устройству.

Это значение не применяется к RDS Custom.

--vpc-security-group-ids (список)

Список групп безопасности EC2 VPC для ассоциации с этим экземпляром БД.

По умолчанию: группа безопасности EC2 VPC по умолчанию для VPC группы подсетей БД.

(строка)

Синтаксис:

"string" "string" ...

--domain (строка)

Идентификатор каталога Active Directory, в котором нужно восстановить экземпляр БД. Домен/должен быть создан перед этой операцией. В настоящее время вы можете создать только экземпляры БД Db2, MySQL, Microsoft SQL Server, Oracle и PostgreSQL в домене Active Directory.

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

Это значение не применяется к RDS Custom.

--domain-fqdn (строка)

Полное доменное имя (FQDN) домена Active Directory.

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

Не может быть длиннее 64 символов.

Пример: mymanagedADtest.mymanagedAD.mydomain

--domain-ou (строка)

Организационная единица Active Directory для присоединения вашего экземпляра БД.

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

Должно быть в формате имени с различающимися уровнями.
Не может быть длиннее 64 символов.

Пример: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain

--domain-auth-secret-arn (строка)

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

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

Не может быть длиннее 64 символов.

Пример: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456

--domain-dns-ips (список)

IP-адреса DNS IPv4 ваших первичных и вторичных контроллеров домена Active Directory.

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

Должны быть указаны два IP-адреса. Если вторичного контроллера домена нет, используйте IP-адрес первичного контроллера домена для обоих записей в списке.

Пример: 123.124.125.126,234.235.236.237

(строка)

Синтаксис:

"string" "string" ...

--copy-tags-to-snapshot | --no-copy-tags-to-snapshot (булево)

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

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

Дополнительную информацию см. в разделе Копирование меток в снимки экземпляров баз данных в руководстве Amazon RDS User Guide .

--domain-iam-role-name (строка)

Имя роли IAM, используемой при выполнении вызовов API для службы каталогов.

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

--enable-iam-database-authentication | --no-enable-iam-database-authentication (логическое значение)

Указывает, следует ли включить сопоставление учетных записей управления доступом и идентификацией Amazon Web Services (IAM) с учетными записями баз данных. По умолчанию сопоставление отключено.

Дополнительную информацию об аутентификации баз данных IAM см. в разделе Аутентификация баз данных IAM для MySQL и PostgreSQL в руководстве Amazon RDS User Guide.

Это свойство не относится к RDS Custom.

--enable-cloudwatch-logs-exports (список)

Список журналов восстановленного экземпляра базы данных для экспорта в CloudWatch Logs. Значения в списке зависят от СУБД. Дополнительную информацию см. в разделе Опубликование журналов базы данных в Amazon CloudWatch Logs в руководстве Amazon RDS User Guide .

Это свойство не относится к RDS Custom.

(строка)

Синтаксис:

"string" "string" ...

--processor-features (список)

Количество ядер процессора и количество потоков на ядро для класса экземпляра базы данных.

Это свойство не относится к RDS Custom.

(структура)

Содержит характеристики процессора класса экземпляра базы данных.

Для указания количества ядер процессора используйте имя характеристики coreCount для параметра Name. Для указания количества потоков на ядро используйте имя характеристики threadsPerCore для параметра Name.

Вы можете настроить характеристики процессора класса экземпляра базы данных для экземпляра базы данных, вызвав одно из следующих действий:

CreateDBInstance
ModifyDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceFromS3
RestoreDBInstanceToPointInTime

Вы можете просмотреть допустимые значения процессора для определенного класса экземпляров, вызвав действие DescribeOrderableDBInstanceOptions и указав класс экземпляра для параметра DBInstanceClass.

Кроме того, вы можете использовать следующие действия для получения информации о процессоре класса экземпляра базы данных:

DescribeDBInstances
DescribeDBSnapshots
DescribeValidDBInstanceModifications

Если вы вызываете DescribeDBInstances , ProcessorFeature возвращает значения, отличные от null, только если выполнены следующие условия:

Вы обращаетесь к экземпляру базы данных Oracle.
Ваш экземпляр базы данных Oracle поддерживает настройку количества ядер процессора и потоков на ядро.
Текущее количество ядер процессора и потоков на ядро установлено в значение, отличное от значения по умолчанию.

Дополнительную информацию см. в разделе Настройка процессора для класса экземпляра базы данных в RDS для Oracle в руководстве Amazon RDS User Guide.

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

Имя характеристики процессора. Допустимые имена — coreCount и threadsPerCore.

Значение -> (строка)

Значение характеристики процессора.

Сокращенный синтаксис:

Name=string,Value=string ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Value": "string"
  }
  ...
]

--use-default-processor-features | --no-use-default-processor-features (логическое значение)

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

Это свойство не относится к RDS Custom.

--db-parameter-group-name (строка)

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

Если вы не укажете значение для DBParameterGroupName , RDS будет использовать значения по умолчанию DBParameterGroup для указанной СУБД.

Это свойство не относится к RDS Custom.

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

При указании должно совпадать с именем существующей группы параметров базы данных.
Длина должна составлять от 1 до 255 символов (буквы, цифры или дефисы).
Первый символ должен быть буквой.
Не должно заканчиваться дефисом и не должно содержать два дефиса подряд.

--deletion-protection | --no-deletion-protection (логическое значение)

Указывает, включена ли защита от удаления для экземпляра базы данных. При включенной защите от удаления база данных не может быть удалена. По умолчанию защита от удаления отключена. Дополнительную информацию см. в разделе Удаление экземпляра базы данных.

--enable-customer-owned-ip | --no-enable-customer-owned-ip (логическое значение)

Указывает, включен ли выделенный IP-адрес клиента (CoIP) для экземпляра базы данных RDS на Outposts.

CoIP обеспечивает локальное или внешнее подключение к ресурсам в ваших подсетях Outpost через вашу локальную сеть. В некоторых случаях CoIP может обеспечить более низкую задержку для подключений к экземпляру базы данных извне вашей виртуальной частной сети (VPC) в вашей локальной сети.

Это свойство не относится к RDS Custom.

Дополнительную информацию об RDS на Outposts см. в разделе Работа с Amazon RDS на Amazon Web Services Outposts в руководстве Amazon RDS User Guide .

Дополнительную информацию о CoIP см. в разделе IP-адреса клиента в руководстве Amazon Web Services Outposts User Guide.

--custom-iam-instance-profile (строка)

Профиль экземпляра, связанный с базовым экземпляром Amazon EC2 для настраиваемого экземпляра базы данных RDS. Профиль экземпляра должен соответствовать следующим требованиям:

Профиль должен существовать в вашей учетной записи.
Профиль должен иметь роль IAM, которую Amazon EC2 имеет право принять.
Имя профиля экземпляра и имя связанной роли IAM должны начинаться с префикса AWSRDSCustom .

Список разрешений, необходимых для роли IAM, см. в разделе Настройка IAM и вашей VPC в руководстве Amazon RDS User Guide .

Это свойство необходимо для RDS Custom.

--backup-target (строка)

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

Возможные значения: outposts (Amazon Web Services Outposts) и region (регион Amazon Web Services). По умолчанию используется значение region.

Дополнительную информацию см. в разделе Работа с Amazon RDS на Amazon Web Services Outposts в руководстве Amazon RDS User Guide.

--network-type (строка)

Тип сети экземпляра базы данных.

Допустимые значения:

IPV4
DUAL

Тип сети определяется значением DBSubnetGroup, указанным для экземпляра базы данных. Экземпляр DBSubnetGroup может поддерживать только протокол IPv4 или протоколы IPv4 и IPv6 (DUAL).

Дополнительную информацию см. в разделе Работа с экземпляром базы данных в VPC в руководстве Amazon RDS User Guide.

--storage-throughput (целое число)

Указывает значение пропускной способности хранения для экземпляра базы данных.

Это свойство не относится к RDS Custom или Amazon Aurora.

--db-cluster-snapshot-identifier (строка)

Идентификатор снимка кластера базы данных Multi-AZ для восстановления.

Дополнительную информацию о кластерах баз данных Multi-AZ см. в разделе Развертывания кластеров баз данных Multi-AZ в руководстве Amazon RDS User Guide.

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

Должен совпадать с идентификатором существующего снимка кластера базы данных Multi-AZ.
Не может быть указан, когда указан DBSnapshotIdentifier.
Должен быть указан, когда DBSnapshotIdentifier не указан.
Если вы восстанавливаете из общего ручного снимка кластера базы данных Multi-AZ, DBClusterSnapshotIdentifier должен быть ARN общего снимка.
Не может быть идентификатором снимка кластера базы данных Aurora.

--allocated-storage (целое число)

Объем памяти (в гигабайтах), который нужно выделить для экземпляра базы данных. Следуйте правилам выделения, указанным в разделе CreateDBInstance.

Это свойство недействительно для RDS for SQL Server.

Примечание

Выделите достаточно памяти для нового экземпляра базы данных, чтобы операция восстановления завершилась успешно. Также вы можете выделить дополнительную память для будущего роста.

--dedicated-log-volume | --no-dedicated-log-volume (логическое значение)

Указывает, включить ли выделенный том журнала (DLV) для экземпляра базы данных.

--ca-certificate-identifier (строка)

Идентификатор сертификата CA, который необходимо использовать для сертификата сервера экземпляра базы данных.

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

Дополнительную информацию см. в разделе Использование SSL/TLS для шифрования соединения с экземпляром базы данных в руководстве Amazon RDS User Guide и в разделе Использование SSL/TLS для шифрования соединения с кластером баз данных в руководстве Amazon Aurora User Guide.

--engine-lifecycle-support (строка)

Тип жизненного цикла для этого экземпляра базы данных.

Примечание

По умолчанию это значение установлено в open-source-rds-extended-support, что подключает ваш экземпляр базы данных к расширенной поддержке Amazon RDS. По окончании стандартной поддержки вы можете избежать оплаты за расширенную поддержку, установив значение в open-source-rds-extended-support-disabled. В этом случае RDS автоматически повысит версию вашей восстановленной базы данных до более новой версии движка, если основная версия движка прошла дату окончания стандартной поддержки.

Это свойство можно использовать для подключения экземпляра базы данных к расширенной поддержке Amazon RDS. С расширенной поддержкой RDS вы можете использовать выбранную основную версию движка на вашем экземпляре базы данных после даты окончания стандартной поддержки для этой версии движка. Дополнительную информацию см. в разделе Расширенная поддержка Amazon RDS с Amazon RDS в руководстве Amazon RDS User Guide.

Это свойство применяется только к RDS for MySQL и RDS for PostgreSQL. Для экземпляров баз данных Amazon Aurora тип жизненного цикла управляется кластером базы данных.

Допустимые значения: open-source-rds-extended-support | open-source-rds-extended-support-disabled

По умолчанию: open-source-rds-extended-support

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

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

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

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

Применяется только к RDS for Oracle.

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

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

Это значение применимо только в том случае, если пароль главного пользователя управляется RDS в Amazon Web Services Secrets Manager для экземпляра базы данных.

Идентификатор ключа Amazon Web Services KMS — это ARN ключа, идентификатор ключа, ARN псевдонима или имя псевдонима для ключа KMS. Чтобы использовать ключ KMS в другом аккаунте Amazon Web Services, укажите ARN ключа или ARN псевдонима.

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

Для вашего аккаунта 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
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-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Подробнее см. руководство по началу работы в руководстве пользователя AWS CLI.

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

Для восстановления экземпляра базы данных из снимка базы данных

Следующий пример restore-db-instance-from-db-snapshot создает новый экземпляр базы данных с именем db7-new-instance с классом экземпляра базы данных db.t3.small из указанного снимка базы данных. Исходный экземпляр базы данных, из которого был сделан снимок, использует устаревший класс экземпляра базы данных, поэтому вы не можете его модернизировать.

aws rds restore-db-instance-from-db-snapshot \
    --db-instance-identifier db7-new-instance \
    --db-snapshot-identifier db7-test-snapshot \
    --db-instance-classdb.t3.small

Вывод:

{
    "DBInstance": {
        "DBInstanceIdentifier": "db7-new-instance",
        "DBInstanceClass": "db.t3.small",
        "Engine": "mysql",
        "DBInstanceStatus": "creating",

        ...output omitted...

        "PreferredMaintenanceWindow": "mon:07:37-mon:08:07",
        "PendingModifiedValues": {},
        "MultiAZ": false,
        "EngineVersion": "5.7.22",
        "AutoMinorVersionUpgrade": true,
        "ReadReplicaDBInstanceIdentifiers": [],
        "LicenseModel": "general-public-license",

        ...output omitted...

        "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:db7-new-instance",
        "IAMDatabaseAuthenticationEnabled": false,
        "PerformanceInsightsEnabled": false,
        "DeletionProtection": false,
        "AssociatedRoles": []
    }
}

Дополнительную информацию см. в разделе Восстановление из снимка базы данных в руководстве пользователя Amazon RDS.

Вывод

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

Содержит сведения об экземпляре базы данных Amazon RDS.

Этот тип данных используется в качестве элемента ответа в операциях CreateDBInstance , CreateDBInstanceReadReplica , DeleteDBInstance , DescribeDBInstances , ModifyDBInstance , PromoteReadReplica , RebootDBInstance , RestoreDBInstanceFromDBSnapshot , RestoreDBInstanceFromS3 , RestoreDBInstanceToPointInTime , StartDBInstance и StopDBInstance .

DBInstanceIdentifier -> (строка)

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

DBInstanceClass -> (строка)

Название класса вычислительной и памяти экземпляра базы данных.

Engine -> (строка)

Двигатель базы данных, используемый для этого экземпляра.

DBInstanceStatus -> (строка)

Текущее состояние этой базы данных.

Сведения о статусах экземпляров баз данных см. в разделе «Просмотр статуса экземпляра базы данных» в Руководстве пользователя Amazon RDS.

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

Время, когда автоматически перезапускается остановленный экземпляр базы данных.

MasterUsername -> (строка)

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

DBName -> (строка)

Изначальное имя базы данных, которое вы предоставили (если требуется) при создании экземпляра базы данных. Это имя возвращается на протяжении всего срока службы вашего экземпляра базы данных. Для экземпляра RDS для Oracle CDB имя идентифицирует PDB, а не CDB.

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

Точка подключения к экземпляру базы данных.

Примечание

Точка подключения может не отображаться для экземпляров со статусом creating .

Address -> (строка)

Указывает DNS-адрес экземпляра базы данных.

Port -> (целое число)

Указывает порт, на котором работает движок базы данных.

HostedZoneId -> (строка)

Указывает идентификатор, который Amazon Route 53 присваивает при создании размещенной зоны.

AllocatedStorage -> (целое число)

Объем памяти в гигабайтах (GiB), выделенный для экземпляра базы данных.

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

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

PreferredBackupWindow -> (строка)

Ежедневный интервал времени, в течение которого выполняются автоматические резервные копии, если автоматические резервные копии включены, как определено BackupRetentionPeriod .

BackupRetentionPeriod -> (целое число)

Количество дней, в течение которых сохраняются автоматические снимки базы данных.

DBSecurityGroups -> (список)

Список элементов группы безопасности базы данных, содержащих подэлементы DBSecurityGroup.Name и DBSecurityGroup.Status .

(структура)

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

ModifyDBInstance
RebootDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceToPointInTime

DBSecurityGroupName -> (строка)

Имя группы безопасности базы данных.

Status -> (строка)

Статус группы безопасности базы данных.

VpcSecurityGroups -> (список)

Список групп безопасности VPC Amazon EC2, к которым относится экземпляр базы данных.

(структура)

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

VpcSecurityGroupId -> (строка)

Имя группы безопасности VPC.

Status -> (строка)

Статус членства в группе безопасности VPC.

В настоящее время единственный допустимый статус — active .

DBParameterGroups -> (список)

Список групп параметров базы данных, примененных к этому экземпляру.

(структура)

Статус группы параметров базы данных.

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

CreateDBInstance
CreateDBInstanceReadReplica
DeleteDBInstance
ModifyDBInstance
RebootDBInstance
RestoreDBInstanceFromDBSnapshot

DBParameterGroupName -> (строка)

Имя группы параметров базы данных.

ParameterApplyStatus -> (строка)

Статус обновлений параметров. Допустимые значения:

applying : изменение параметров группы применяется к базе данных.
failed-to-apply : группа параметров находится в недопустимом состоянии.
in-sync : изменение параметров группы синхронизировано с базой данных.
pending-database-upgrade : изменение параметров группы будет применено после обновления экземпляра базы данных.
pending-reboot : изменение параметров группы будет применено после перезагрузки экземпляра базы данных.

AvailabilityZone -> (строка)

Название зоны доступности, в которой находится экземпляр базы данных.

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

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

DBSubnetGroupName -> (строка)

Имя группы подсетей базы данных.

DBSubnetGroupDescription -> (строка)

Предоставляет описание группы подсетей базы данных.

VpcId -> (строка)

Предоставляет VpcId группы подсетей базы данных.

SubnetGroupStatus -> (строка)

Предоставляет состояние группы подсетей базы данных.

Subnets -> (список)

Содержит список элементов Subnet .

(структура)

Этот тип данных используется в качестве элемента ответа для операции DescribeDBSubnetGroups .

SubnetIdentifier -> (строка)

Идентификатор подсети.

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

Содержит сведения о зоне доступности.

Этот тип данных используется в качестве элемента в типе данных OrderableDBInstanceOption .

Name -> (строка)

Название зоны доступности.

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

Если подсеть связана с Outpost, это значение указывает на Outpost.

Дополнительную информацию об RDS в Outpost см. в разделе Amazon RDS на Amazon Web Services Outposts в Руководстве пользователя Amazon RDS.

Arn -> (строка)

Amazon Resource Name (ARN) Outpost.

SubnetStatus -> (строка)

Состояние подсети.

DBSubnetGroupArn -> (строка)

Amazon Resource Name (ARN) для группы подсетей базы данных.

SupportedNetworkTypes -> (список)

Тип сети группы подсетей базы данных.

Допустимые значения:

IPV4
DUAL

DBSubnetGroup может поддерживать только протокол IPv4 или протоколы IPv4 и IPv6 (DUAL ).

Дополнительные сведения см. в разделе Работа с экземпляром базы данных в VPC в Руководстве пользователя Amazon RDS.

(строка)

PreferredMaintenanceWindow -> (строка)

Интервал времени в неделю, в который может выполняться техническое обслуживание системы в формате универсального времени координации (UTC).

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

Информация о pending изменениях в экземпляре БД. Эта информация возвращается только при наличии pending изменений. Конкретные изменения определяются дочерними элементами.

DBInstanceClass -> (строка)

Название класса вычислительной и оперативной памяти для экземпляра БД.

AllocatedStorage -> (целое число)

Размер выделенного хранилища для экземпляра БД, указанный в гигабайтах (GiB).

MasterUserPassword -> (строка)

Сведения о мастер-кредитах для экземпляра БД.

Port -> (целое число)

Порт для экземпляра БД.

BackupRetentionPeriod -> (целое число)

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

MultiAZ -> (булево)

Указывает, будет ли экземпляр БД с поддержкой Single-AZ переведен на развертывание Multi-AZ.

EngineVersion -> (строка)

Версия СУБД.

LicenseModel -> (строка)

Модель лицензии для экземпляра БД.

Допустимые значения: license-included | bring-your-own-license | general-public-license

Iops -> (целое число)

Значение Provisioned IOPS для экземпляра БД.

DBInstanceIdentifier -> (строка)

Идентификатор базы данных для экземпляра БД.

StorageType -> (строка)

Тип хранилища экземпляра БД.

CACertificateIdentifier -> (строка)

Идентификатор сертификата CA для экземпляра БД.

Дополнительную информацию см. в разделе Использование SSL/TLS для шифрования подключения к экземпляру БД в руководстве пользователя Amazon RDS и Использование SSL/TLS для шифрования подключения к кластеру БД в руководстве пользователя Amazon Aurora.

DBSubnetGroupName -> (строка)

Группа подсетей БД для экземпляра БД.

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

Список типов журналов, конфигурация которых все еще pending. Другими словами, эти типы журналов находятся в процессе активации или деактивации.

LogTypesToEnable -> (список)

Типы журналов, которые находятся в процессе деактивации. После деактивации эти типы журналов не экспортируются в CloudWatch Logs.

(строка)

LogTypesToDisable -> (список)

Типы журналов, которые находятся в процессе активации. После активации эти типы журналов экспортируются в CloudWatch Logs.

(строка)

ProcessorFeatures -> (список)

Количество ядер процессора и количество потоков на ядро для класса экземпляра БД.

(структура)

Содержит характеристики процессора класса экземпляра БД.

Для указания количества ядер процессора используйте имя параметра coreCount для параметра Name. Для указания количества потоков на ядро используйте имя параметра threadsPerCore для параметра Name.

Вы можете задать характеристики процессора класса экземпляра БД для экземпляра БД, вызвав одно из следующих действий:

CreateDBInstance
ModifyDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceFromS3
RestoreDBInstanceToPointInTime

Вы можете просмотреть допустимые значения процессора для определенного класса экземпляра, вызвав действие DescribeOrderableDBInstanceOptions и указав класс экземпляра для параметра DBInstanceClass.

Кроме того, вы можете использовать следующие действия для получения информации о процессоре класса экземпляра БД:

DescribeDBInstances
DescribeDBSnapshots
DescribeValidDBInstanceModifications

Если вы вызываете DescribeDBInstances, ProcessorFeature возвращает значения, отличные от null, только в случае выполнения следующих условий:

Вы обращаетесь к экземпляру Oracle БД.
Ваш экземпляр Oracle БД поддерживает настройку количества ядер процессора и потоков на ядро.
Текущее количество ядер процессора и потоков на ядро установлено в значение, отличное от значения по умолчанию.

Дополнительную информацию см. в разделе Настройка процессора для класса экземпляра БД в RDS for Oracle в руководстве пользователя Amazon RDS.

Name -> (строка)

Имя характеристики процессора. Допустимые имена — coreCount и threadsPerCore.

Value -> (строка)

Значение характеристики процессора.

IAMDatabaseAuthenticationEnabled -> (булево)

Указывает, включено ли отображение учетных записей Amazon Web Services Identity and Access Management (IAM) в учетные записи баз данных.

AutomationMode -> (строка)

Режим автоматизации экземпляра RDS Custom DB: full или all-paused. При значении full экземпляр БД автоматизирует мониторинг и восстановление экземпляра. При значении all-paused экземпляр приостанавливает автоматизацию на период, установленный значением --resume-full-automation-mode-minutes.

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

Количество минут приостановки автоматизации. После завершения этого периода RDS Custom возобновляет полную автоматизацию. Минимальное значение — 60 (по умолчанию). Максимальное значение — 1440.

StorageThroughput -> (целое число)

Пропускная способность хранилища экземпляра БД.

Engine -> (строка)

СУБД экземпляра БД.

DedicatedLogVolume -> (булево)

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

MultiTenant -> (булево)

Указывает, будет ли экземпляр БД переведен на многопользовательскую конфигурацию (TRUE) или на однопользовательскую (FALSE).

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

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

MultiAZ -> (булево)

Указывает, является ли экземпляр БД развертыванием Multi-AZ. Данное свойство не применимо к экземплярам RDS Custom DB.

EngineVersion -> (строка)

Версия СУБД.

AutoMinorVersionUpgrade -> (булево)

Указывает, применяются ли автоматически исправления для незначительных версий.

Дополнительную информацию об автоматических обновлениях незначительных версий см. в разделе Автоматическое обновление незначительной версии.

ReadReplicaSourceDBInstanceIdentifier -> (строка)

Идентификатор исходного экземпляра БД, если этот экземпляр является репликой чтения.

ReadReplicaDBInstanceIdentifiers -> (список)

Идентификаторы реплик чтения, связанных с этим экземпляром БД.

(строка)

ReadReplicaDBClusterIdentifiers -> (список)

Идентификаторы кластеров Aurora DB, в которые экземпляр БД RDS реплицируется в качестве реплики чтения. Например, при создании реплики чтения Aurora для экземпляра БД RDS for MySQL отображается кластер Aurora MySQL DB для реплики чтения Aurora. Данный вывод не содержит информацию о репликах чтения Aurora между регионами.

Примечание

В настоящее время каждый экземпляр БД RDS может иметь только одну реплику чтения Aurora.

(строка)

ReplicaMode -> (строка)

Открытый режим реплики чтения Oracle. Значение по умолчанию — open-read-only. Дополнительную информацию см. в разделе Работа с репликами чтения Oracle для Amazon RDS в руководстве пользователя Amazon RDS.

Примечание

Это свойство поддерживается только в RDS for Oracle.

LicenseModel -> (строка)

Информация о модели лицензии для данного экземпляра БД. Это свойство не применимо к экземплярам Amazon Aurora или RDS Custom DB.

Iops -> (целое число)

Значение Provisioned IOPS (операций ввода-вывода в секунду) для экземпляра БД.

OptionGroupMemberships -> (список)

Список членств в группах параметров для данного экземпляра БД.

(структура)

Предоставляет сведения о группах параметров, членами которых является экземпляр БД.

OptionGroupName -> (строка)

Имя группы параметров, к которой принадлежит экземпляр.

Status -> (строка)

Статус членства экземпляра БД в группе параметров. Допустимые значения: in-sync , pending-apply , pending-removal , pending-maintenance-apply , pending-maintenance-removal , applying , removing и failed.

CharacterSetName -> (строка)

При наличии указывает имя набора символов, связанного с этим экземпляром.

NcharCharacterSetName -> (строка)

Имя набора символов NCHAR для экземпляра Oracle БД. Этот набор символов определяет кодировку Unicode для данных, хранящихся в столбцах таблиц типа NCHAR, NCLOB или NVARCHAR2.

SecondaryAvailabilityZone -> (строка)

При наличии указывает имя вторичной зоны доступности для экземпляра БД с поддержкой Multi-AZ.

PubliclyAccessible -> (булево)

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

Если экземпляр БД доступен для публичного доступа и вы подключаетесь извне виртуальной частной сети (VPC) экземпляра БД, его конечная точка DNS разрешается до публичного IP-адреса. При подключении внутри той же VPC, что и экземпляр БД, конечная точка разрешается до частного IP-адреса. Доступ к кластеру в конечном итоге контролируется используемой группой безопасности. Этот публичный доступ не разрешен, если группа безопасности, назначенная кластеру БД, его не разрешает.

Если экземпляр БД недоступен для публичного доступа, он является внутренним экземпляром БД с именем DNS, разрешаемым до частного IP-адреса.

Дополнительную информацию см. в CreateDBInstance.

StatusInfos -> (список)

Статус реплики чтения. Если экземпляр БД не является репликой чтения, значение пустое.

(структура)

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

StatusType -> (строка)

Это значение в настоящее время равно «read replication».

Normal -> (булево)

Указывает, работает ли экземпляр нормально (TRUE) или находится в состоянии ошибки (FALSE).

Status -> (строка)

Состояние экземпляра БД. Для StatusType, равного «read replica», значения могут быть replicating, replication stop point set, replication stop point reached, error, stopped или terminated.

Message -> (строка)

Подробности ошибки, если у экземпляра есть ошибка. Если экземпляр не находится в состоянии ошибки, это значение пустое.

StorageType -> (строка)

Тип хранилища, связанный с экземпляром БД.

TdeCredentialArn -> (строка)

ARN из хранилища ключей, с которым связан экземпляр для шифрования TDE.

DbInstancePort -> (целое число)

Порт, на котором прослушивает экземпляр БД. Если экземпляр БД является частью кластера БД, этот порт может отличаться от порта кластера БД.

DBClusterIdentifier -> (строка)

Если экземпляр БД является членом кластера БД, указывает имя кластера БД, членом которого является данный экземпляр БД.

StorageEncrypted -> (булево)

Указывает, зашифрован ли экземпляр БД.

KmsKeyId -> (строка)

Если StorageEncrypted включен, идентификатор ключа KMS Amazon Web Services для зашифрованного экземпляра БД.

Идентификатор ключа KMS Amazon Web Services представляет собой ARN ключа, ID ключа, ARN псевдонима или имя псевдонима для ключа KMS.

DbiResourceId -> (строка)

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

CACertificateIdentifier -> (string)

Идентификатор сертификата CA для этого экземпляра базы данных.

Дополнительную информацию см. в разделе Использование SSL/TLS для шифрования подключения к экземпляру базы данных в руководстве Amazon RDS User Guide и в разделе Использование SSL/TLS для шифрования подключения к кластеру баз данных в руководстве Amazon Aurora User Guide.

DomainMemberships -> (list)

Записи членства в домене Active Directory, связанные с экземпляром базы данных.

(структура)

Запись членства в домене Active Directory, связанная с экземпляром базы данных или кластером.

Domain -> (string)

Идентификатор домена Active Directory.

Status -> (string)

Состояние членства в домене Active Directory для экземпляра базы данных или кластера. Значения включают joined , pending-join , failed и так далее.

FQDN -> (string)

Полное доменное имя (FQDN) домена Active Directory.

IAMRoleName -> (string)

Имя роли IAM, используемой при выполнении вызовов API к службе каталогов.

OU -> (string)

Организационная единица Active Directory для экземпляра базы данных или кластера.

AuthSecretArn -> (string)

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

DnsIps -> (list)

IP-адреса IPv4 DNS первичных и вторичных контроллеров домена Active Directory.

(string)

CopyTagsToSnapshot -> (boolean)

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

Это свойство не применяется к экземплярам баз данных Amazon Aurora. Копирование тегов в снимки управляется кластером баз данных. Установка этого значения для экземпляра базы данных Aurora не влияет на настройку кластера баз данных. Дополнительную информацию см. в разделе DBCluster .

MonitoringInterval -> (integer)

Интервал в секундах между моментами сбора данных метрик с расширенным мониторингом для экземпляра базы данных.

EnhancedMonitoringResourceArn -> (string)

Amazon Resource Name (ARN) потока журнала Amazon CloudWatch Logs, который получает данные метрик с расширенным мониторингом для экземпляра базы данных.

MonitoringRoleArn -> (string)

ARN роли IAM, которая разрешает RDS отправлять метрики расширенного мониторинга в Amazon CloudWatch Logs.

PromotionTier -> (integer)

Порядок приоритета, в котором реплика Aurora повышается до первичного экземпляра после сбоя существующего первичного экземпляра. Дополнительную информацию см. в разделе Толерантность к отказам для кластера баз данных Aurora в руководстве Amazon Aurora User Guide.

DBInstanceArn -> (string)

Amazon Resource Name (ARN) для экземпляра базы данных.

Timezone -> (string)

Временная зона экземпляра базы данных. В большинстве случаев элемент Timezone пуст. Содержимое Timezone отображается только для экземпляров RDS для Db2 и RDS для SQL Server, которые были созданы с указанием временной зоны.

IAMDatabaseAuthenticationEnabled -> (boolean)

Указывает, включена ли сопоставление учетных записей Amazon Web Services Identity and Access Management (IAM) с учетными записями баз данных для экземпляра базы данных.

Список версий движков, поддерживающих аутентификацию баз данных IAM, см. в разделе Аутентификация баз данных IAM в руководстве Amazon RDS User Guide и разделе Аутентификация баз данных IAM в Aurora в руководстве Amazon Aurora User Guide.

DatabaseInsightsMode -> (string)

Режим Database Insights, включенный для экземпляра.

PerformanceInsightsEnabled -> (boolean)

Указывает, включен ли Performance Insights для экземпляра базы данных.

PerformanceInsightsKMSKeyId -> (string)

Идентификатор ключа шифрования Amazon Web Services KMS для шифрования данных Performance Insights.

Идентификатор ключа шифрования Amazon Web Services KMS представляет собой ARN ключа, идентификатор ключа, ARN псевдонима или имя псевдонима для ключа KMS.

PerformanceInsightsRetentionPeriod -> (integer)

Количество дней для хранения данных Performance Insights.

Допустимые значения:

7
месяц * 31, где месяц — число месяцев от 1 до 23. Примеры: 93 (3 месяца * 31), 341 (11 месяцев * 31), 589 (19 месяцев * 31)
731

По умолчанию: 7 дней

EnabledCloudwatchLogsExports -> (list)

Список типов журналов, которые этот экземпляр базы данных настроен на экспорт в CloudWatch Logs.

Типы журналов различаются в зависимости от движка базы данных. Дополнительную информацию о типах журналов для каждого движка базы данных см. в разделе Мониторинг файлов журналов Amazon RDS в руководстве Amazon RDS User Guide.

(string)

ProcessorFeatures -> (list)

Количество ядер процессора и количество потоков на ядро для класса экземпляра базы данных.

(структура)

Содержит характеристики процессора класса экземпляра базы данных.

Вы можете настроить характеристики процессора класса экземпляра базы данных для экземпляра базы данных при вызове одного из следующих действий:

CreateDBInstance
ModifyDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceFromS3
RestoreDBInstanceToPointInTime

DescribeDBInstances
DescribeDBSnapshots
DescribeValidDBInstanceModifications

Если вы вызываете DescribeDBInstances, ProcessorFeature возвращает ненулевые значения только в том случае, если выполнены следующие условия:

Вы обращаетесь к экземпляру Oracle DB.
Ваш класс экземпляра Oracle DB поддерживает настройку количества ядер процессора и количества потоков на ядро.
Текущее количество ядер процессора и потоков на ядро установлено не по умолчанию.

Name -> (string)

Имя характеристики процессора. Допустимые имена — coreCount и threadsPerCore.

Value -> (string)

Значение характеристики процессора.

DeletionProtection -> (boolean)

Указывает, включена ли защита от удаления для экземпляра базы данных. При включенной защите от удаления базу данных удалить нельзя. Дополнительную информацию см. в разделе Удаление экземпляра базы данных.

AssociatedRoles -> (list)

Роли Amazon Web Services Identity and Access Management (IAM), связанные с экземпляром базы данных.

(структура)

Информация о роли Amazon Web Services Identity and Access Management (IAM), связанной с экземпляром базы данных.

RoleArn -> (string)

Amazon Resource Name (ARN) роли IAM, связанной с экземпляром базы данных.

FeatureName -> (string)

Имя характеристики, связанной с ролью Amazon Web Services Identity and Access Management (IAM). Дополнительную информацию о поддерживаемых именах характеристик см. в разделе DBEngineVersion .

Status -> (string)

Информация о состоянии связи между ролью IAM и экземпляром базы данных. Свойство Status возвращает одно из следующих значений:

ACTIVE — ARN роли IAM связан с экземпляром базы данных и может быть использован для доступа к другим службам Amazon Web Services от вашего имени.
PENDING — ARN роли IAM связывается с экземпляром базы данных.
INVALID — ARN роли IAM связан с экземпляром базы данных, но экземпляр базы данных не может принять роль IAM для доступа к другим службам Amazon Web Services от вашего имени.

ListenerEndpoint -> (structure)

Точка подключения слушателя для SQL Server Always On.

Address -> (string)

Указывает DNS-адрес экземпляра базы данных.

Port -> (integer)

Указывает порт, на котором работает движок базы данных.

HostedZoneId -> (string)

Указывает ID, назначенный Amazon Route 53 при создании зоны размещения.

MaxAllocatedStorage -> (integer)

Максимальный объем в гигабайтах (GiB), до которого Amazon RDS может автоматически масштабировать хранилище экземпляра базы данных.

TagList -> (list)

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

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

(структура)

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

Key -> (string)

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

Value -> (string)

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

DBInstanceAutomatedBackupsReplications -> (list)

Список реплицированных автоматических резервных копий, связанных с экземпляром базы данных.

(структура)

Автоматические резервные копии экземпляра базы данных, реплицированные в другой регион Amazon Web Services. Они включают системные резервные копии, журналы транзакций и свойства экземпляра базы данных.

DBInstanceAutomatedBackupsArn -> (string)

Amazon Resource Name (ARN) реплицированных автоматических резервных копий.

CustomerOwnedIpEnabled -> (boolean)

Указывает, включён ли для экземпляра базы данных RDS на Outposts клиентский IP-адрес (CoIP).

CoIP обеспечивает локальное или внешнее подключение к ресурсам в ваших подсетях Outpost через вашу локальную сеть. В некоторых случаях CoIP может обеспечить более низкую задержку для подключений к экземпляру базы данных извне его виртуальной частной сети (VPC) в вашей локальной сети.

Дополнительную информацию об RDS на Outposts см. в разделе Работа с Amazon RDS на Amazon Web Services Outposts в Руководстве пользователя Amazon RDS .

Дополнительную информацию о CoIP см. в разделе Клиентские IP-адреса в Руководстве пользователя Amazon Web Services Outposts .

AwsBackupRecoveryPointArn -> (строка)

Идентификатор ресурса Amazon (ARN) точки восстановления в Amazon Web Services Backup.

ActivityStreamStatus -> (строка)

Состояние потока активности базы данных.

ActivityStreamKmsKeyId -> (строка)

Идентификатор ключа KMS Amazon Web Services, используемый для шифрования сообщений в потоке активности базы данных. Идентификатор ключа KMS Amazon Web Services — это ARN ключа, идентификатор ключа, ARN псевдонима или имя псевдонима для ключа KMS.

ActivityStreamKinesisStreamName -> (строка)

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

ActivityStreamMode -> (строка)

Режим потока активности базы данных. События базы данных, такие как изменение или доступ, генерируют событие потока активности. RDS для Oracle всегда обрабатывает эти события асинхронно.

ActivityStreamEngineNativeAuditFieldsIncluded -> (булево)

Указывает, включены ли встроенные в движок поля аудита в потоке активности базы данных.

AutomationMode -> (строка)

Режим автоматизации экземпляра базы данных RDS Custom: full или all paused . Если full , экземпляр базы данных автоматизирует мониторинг и восстановление экземпляра. Если all paused , экземпляр приостанавливает автоматизацию на период, заданный значением --resume-full-automation-mode-minutes .

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

Количество минут для приостановки автоматизации. По окончании периода RDS Custom возобновляет полную автоматизацию. Минимальное значение — 60 (по умолчанию). Максимальное значение — 1440.

CustomIamInstanceProfile -> (строка)

Профиль экземпляра, связанный с базовым экземпляром Amazon EC2 экземпляра базы данных RDS Custom. Профиль экземпляра должен соответствовать следующим требованиям:

Профиль должен существовать в вашем аккаунте.
Профиль должен иметь роль IAM, которую Amazon EC2 имеет разрешения принять.
Имя профиля экземпляра и имя связанной роли IAM должны начинаться с префикса AWSRDSCustom .

Список разрешений, необходимых для роли IAM, см. в разделе Настройка IAM и вашей VPC в Руководстве пользователя Amazon RDS .

BackupTarget -> (строка)

Место хранения автоматических резервных копий и ручных снимков: Amazon Web Services Outposts или регион Amazon Web Services.

NetworkType -> (строка)

Тип сети экземпляра базы данных.

Тип сети определяется значением DBSubnetGroup , заданным для экземпляра базы данных. DBSubnetGroup может поддерживать только протокол IPv4 или протоколы IPv4 и IPv6 (DUAL ).

Дополнительную информацию см. в разделах Работа с экземпляром базы данных в VPC в Руководстве пользователя Amazon RDS и Работа с экземпляром базы данных в VPC в Руководстве пользователя Amazon Aurora.

Допустимые значения: IPV4 | DUAL

ActivityStreamPolicyStatus -> (строка)

Состояние политики потока активности.

StorageThroughput -> (целое число)

Пропускная способность хранилища для экземпляра базы данных.

Это значение применяется только к типу хранилища gp3 .

DBSystemId -> (строка)

Идентификатор системы Oracle (Oracle SID) для базы данных контейнера (CDB). Oracle SID также является именем CDB. Это значение применимо только для экземпляров RDS Custom DB.

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

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

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

SecretArn -> (строка)

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

SecretStatus -> (строка)

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

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

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

KmsKeyId -> (строка)

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

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

Подробности сертификата сервера экземпляра базы данных.

CAIdentifier -> (строка)

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

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

Дата истечения срока действия сертификата сервера экземпляра базы данных.

ReadReplicaSourceDBClusterIdentifier -> (строка)

Идентификатор исходной кластера базы данных, если этот экземпляр базы данных является репликой чтения.

PercentProgress -> (строка)

Прогресс операции оптимизации хранилища в процентах.

DedicatedLogVolume -> (булево)

Указывает, включён ли для экземпляра базы данных выделенный объём логов (DLV).

IsStorageConfigUpgradeAvailable -> (булево)

Указывает, рекомендуется ли обновление конфигурации файловой системы хранения для экземпляра базы данных. Для миграции к предпочтительной конфигурации можно либо выполнить развертывание синего/зелёного, либо создать реплику чтения из экземпляра базы данных. Дополнительную информацию см. в разделе Обновление файловой системы хранилища для экземпляра базы данных.

MultiTenant -> (булево)

Указывает, находится ли экземпляр базы данных в многопользовательской конфигурации (ИСТИНА) или в однопользовательской конфигурации (ЛОЖЬ).

EngineLifecycleSupport -> (строка)

Тип жизненного цикла для экземпляра базы данных.

Дополнительную информацию см. в разделе CreateDBInstance.