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

Описание

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

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

Примечание

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

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

Синтаксис

  restore-db-instance-to-point-in-time
[--source-db-instance-identifier <value>]
--target-db-instance-identifier <value>
[--restore-time <value>]
[--use-latest-restorable-time | --no-use-latest-restorable-time]
[--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>]
[--copy-tags-to-snapshot | --no-copy-tags-to-snapshot]
[--tags <value>]
[--storage-type <value>]
[--tde-credential-arn <value>]
[--tde-credential-password <value>]
[--vpc-security-group-ids <value>]
[--domain <value>]
[--domain-iam-role-name <value>]
[--domain-fqdn <value>]
[--domain-ou <value>]
[--domain-auth-secret-arn <value>]
[--domain-dns-ips <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]
[--source-dbi-resource-id <value>]
[--max-allocated-storage <value>]
[--source-db-instance-automated-backups-arn <value>]
[--enable-customer-owned-ip | --no-enable-customer-owned-ip]
[--custom-iam-instance-profile <value>]
[--backup-target <value>]
[--network-type <value>]
[--storage-throughput <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]

Параметры

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

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

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

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

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

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

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

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

--restore-time (метка времени)

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

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

Должно быть значение во формате всемирного координированного времени (UTC).
Должно быть раньше последнего восстанавливаемого времени для экземпляра базы данных.
Не может быть указано, если параметр UseLatestRestorableTime включен.

Пример: 2009-09-07T23:45:00Z

--use-latest-restorable-time | --no-use-latest-restorable-time (булево)

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

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

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

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

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

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

--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 для Db2 требуют дополнительной настройки. Модель «Используйте свою лицензию» (BYOL) требует пользовательской группы параметров и самостоятельно управляемой лицензии Amazon Web Services License Manager. Модель лицензии Db2 через Amazon Web Services Marketplace требует подписки Amazon Web Services Marketplace. Дополнительную информацию см. в разделе «Варианты лицензирования Amazon RDS для 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 Custom
RDS for Db2
RDS for MariaDB
RDS for MySQL

--engine (строка)

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

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

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

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 (целое число)

Количество Provisioned IOPS (операций ввода/вывода в секунду) для первоначального выделения для экземпляра базы данных.

Это свойство не применяется к SQL Server.

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

Должно быть целым числом, большим 1000.

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

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

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

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

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

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

--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, если указан параметр Iops. В противном случае gp3.

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

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

--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, в котором требуется восстановить экземпляр базы данных. Создайте домен перед выполнением этой команды. В настоящее время вы можете создавать только экземпляры баз данных MySQL, Microsoft SQL Server, Oracle и PostgreSQL в домене Active Directory.

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

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

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

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

Это свойство не применяется к экземплярам баз данных 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" ...

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

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

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

Дополнительную информацию об аутентификации IAM для баз данных см. в разделе IAM Database Authentication for MySQL and PostgreSQL в Руководстве пользователя Amazon RDS.

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

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

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

(строка)

Синтаксис:

"string" "string" ...

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

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

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

(структура)

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

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

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

CreateDBInstance
ModifyDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceFromS3
RestoreDBInstanceToPointInTime

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

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

DescribeDBInstances
DescribeDBSnapshots
DescribeValidDBInstanceModifications

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

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

Дополнительную информацию см. в разделе Configuring the processor for a DB instance class in RDS for Oracle в Руководстве пользователя Amazon RDS.

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

Имя характеристики процессора. Допустимые имена — 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, будет использоваться значение по умолчанию DBParameterGroup для указанного движка БД.

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

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

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

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

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

--source-dbi-resource-id (строка)

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

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

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

Дополнительную информацию об этом значении, включая ограничения, см. в разделе Managing capacity automatically with Amazon RDS storage autoscaling в Руководстве пользователя Amazon RDS.

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

--source-db-instance-automated-backups-arn (строка)

Amazon Resource Name (ARN) реплицированных автоматических резервных копий, из которых выполняется восстановление, например, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

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

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

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

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

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

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

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

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

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

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

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

Это значение необходимо для RDS Custom.

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

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

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

outposts (Amazon Web Services Outposts)
region (Регион Amazon Web Services)

По умолчанию: region

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

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

Тип сети экземпляра БД.

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

Дополнительную информацию см. в разделе Working with a DB instance in a VPC в Руководстве пользователя Amazon RDS.

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

IPV4
DUAL

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

Значение пропускной способности хранилища для экземпляра БД.

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

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

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

Это значение недопустимо для RDS for SQL Server.

Примечание

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

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

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

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

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

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

Дополнительную информацию см. в разделе Using SSL/TLS to encrypt a connection to a DB instance в Руководстве пользователя Amazon RDS и Using SSL/TLS to encrypt a connection to a DB cluster в Руководстве пользователя Amazon Aurora.

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

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

Примечание

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

Вы можете использовать это значение, чтобы подключить экземпляр БД к расширенной поддержке Amazon RDS. С расширенной поддержкой RDS вы можете запускать выбранную основную версию движка на вашем экземпляре БД после окончания стандартной поддержки этой версии движка. Дополнительную информацию см. в разделе Amazon RDS Extended Support with Amazon RDS в Руководстве пользователя Amazon RDS.

Это значение применяется только к 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 в восстановленном экземпляре БД.

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

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

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

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

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

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

Идентификатор ключа KMS Amazon Web Services — это 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 Region.

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

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

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

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

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

Примеры

Примечание

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

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

Пример 1: Восстановление экземпляра базы данных до определенного момента времени

Следующий пример восстанавливает test-instance на новый экземпляр базы данных под названием restored-test-instance, начиная с указанного момента времени.

aws rds restore-db-instance-to-point-in-time \
    --source-db-instance-identifier test-instance \
    --target-db-instance restored-test-instance \
    --restore-time 2018-07-30T23:45:00.000Z

Вывод:

{
    "DBInstance": {
        "AllocatedStorage": 20,
        "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:restored-test-instance",
        "DBInstanceStatus": "creating",
        "DBInstanceIdentifier": "restored-test-instance",
        ...some output omitted...
    }
}

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

Пример 2: Восстановление экземпляра базы данных до определенного момента времени из реплицированного резервного копирования

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

aws rds restore-db-instance-to-point-in-time \
    --source-db-instance-automated-backups-arn "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" \
    --target-db-instance-identifier myorclinstance-from-replicated-backup \
    --restore-time 2020-12-08T18:45:00.000Z

Вывод:

{
    "DBInstance": {
        "DBInstanceIdentifier": "myorclinstance-from-replicated-backup",
        "DBInstanceClass": "db.t3.micro",
        "Engine": "oracle-se2",
        "DBInstanceStatus": "creating",
        "MasterUsername": "admin",
        "DBName": "ORCL",
        "AllocatedStorage": 20,
        "PreferredBackupWindow": "07:45-08:15",
        "BackupRetentionPeriod": 14,
        ... some output omitted ...
        "DbiResourceId": "db-KGLXG75BGVIWKQT7NQ4EXAMPLE",
        "CACertificateIdentifier": "rds-ca-2019",
        "DomainMemberships": [],
        "CopyTagsToSnapshot": false,
        "MonitoringInterval": 0,
        "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:myorclinstance-from-replicated-backup",
        "IAMDatabaseAuthenticationEnabled": false,
        "PerformanceInsightsEnabled": false,
        "DeletionProtection": false,
        "AssociatedRoles": [],
        "TagList": []
    }
}

Для получения дополнительной информации см. Восстановление до указанного момента времени из реплицированного резервного копирования в руководстве пользователя 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 -> (список)

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

(структура)

Этот тип данных используется в качестве элемента ответа для запросов о членстве в группе безопасности 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 в Outposts см. в разделе «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 -> (структура)

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

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 -> (структура)

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

LogTypesToEnable -> (список)

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

(строка)

LogTypesToDisable -> (список)

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

(строка)

ProcessorFeatures -> (список)

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

(структура)

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

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

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

CreateDBInstance
ModifyDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceFromS3
RestoreDBInstanceToPointInTime

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

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

DescribeDBInstances
DescribeDBSnapshots
DescribeValidDBInstanceModifications

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

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

Дополнительную информацию см. в разделе Настройка процессора для класса экземпляра базы данных в RDS для 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 DB реплицируется в качестве реплики чтения. Например, при создании реплики чтения Aurora для экземпляра RDS для MySQL отображается кластер Aurora MySQL DB для реплики чтения Aurora. В этом выводе отсутствует информация о репликах чтения Aurora в разных регионах.

Примечание

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

(строка)

ReplicaMode -> (строка)

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

Примечание

Это свойство поддерживается только в RDS для 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 -> (строка)

В настоящее время это «репликация чтения».

Normal -> (булево)

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

Status -> (строка)

Статус экземпляра базы данных. Для StatusType типа реплики чтения возможны значения replicating, replication stop point set, replication stop point reached, error, stopped или terminated.

Message -> (строка)

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

StorageType -> (строка)

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

TdeCredentialArn -> (строка)

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

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

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

DBClusterIdentifier -> (строка)

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

StorageEncrypted -> (булево)

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

KmsKeyId -> (строка)

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

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

DbiResourceId -> (строка)

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

CACertificateIdentifier -> (строка)

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

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

DomainMemberships -> (список)

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

(структура)

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

Domain -> (строка)

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

Status -> (строка)

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

FQDN -> (строка)

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

IAMRoleName -> (строка)

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

OU -> (строка)

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

AuthSecretArn -> (строка)

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

DnsIps -> (список)

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

(строка)

CopyTagsToSnapshot -> (булево)

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

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

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

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

EnhancedMonitoringResourceArn -> (строка)

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

MonitoringRoleArn -> (строка)

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

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

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

DBInstanceArn -> (строка)

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

Timezone -> (строка)

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

IAMDatabaseAuthenticationEnabled -> (булево)

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

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

DatabaseInsightsMode -> (строка)

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

PerformanceInsightsEnabled -> (булево)

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

PerformanceInsightsKMSKeyId -> (строка)

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

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

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

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

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

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

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

EnabledCloudwatchLogsExports -> (список)

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

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

(строка)

ProcessorFeatures -> (список)

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

(структура)

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

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

CreateDBInstance
ModifyDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceFromS3
RestoreDBInstanceToPointInTime

DescribeDBInstances
DescribeDBSnapshots
DescribeValidDBInstanceModifications

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

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

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

Name -> (строка)

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

Value -> (строка)

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

DeletionProtection -> (булево)

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

AssociatedRoles -> (список)

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

(структура)

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

RoleArn -> (строка)

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

FeatureName -> (строка)

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

Status -> (строка)

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

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

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

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

Address -> (строка)

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

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

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

HostedZoneId -> (строка)

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

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

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

TagList -> (список)

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

Для получения дополнительной информации см. Размещение тегов на ресурсах Amazon RDS в Руководстве пользователя Amazon RDS или Размещение тегов на ресурсах Amazon Aurora и Amazon RDS в Руководстве пользователя Amazon Aurora.

(структура)

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

Key -> (строка)

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

Value -> (строка)

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

DBInstanceAutomatedBackupsReplications -> (список)

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

(структура)

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

DBInstanceAutomatedBackupsArn -> (строка)

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

CustomerOwnedIpEnabled -> (булево)

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

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

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

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

AwsBackupRecoveryPointArn -> (строка)

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

ActivityStreamStatus -> (строка)

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

ActivityStreamKmsKeyId -> (строка)

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

ActivityStreamKinesisStreamName -> (строка)

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

ActivityStreamMode -> (строка)

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

ActivityStreamEngineNativeAuditFieldsIncluded -> (булево)

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

AutomationMode -> (строка)

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

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

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

CustomIamInstanceProfile -> (строка)

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

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

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

BackupTarget -> (строка)

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

NetworkType -> (строка)

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

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

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

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

ActivityStreamPolicyStatus -> (строка)

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

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

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

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

DBSystemId -> (строка)

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

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

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

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

SecretArn -> (строка)

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

SecretStatus -> (строка)

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

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

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

KmsKeyId -> (строка)

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

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

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

CAIdentifier -> (строка)

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

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

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

ReadReplicaSourceDBClusterIdentifier -> (строка)

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

PercentProgress -> (строка)

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

DedicatedLogVolume -> (булево)

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

IsStorageConfigUpgradeAvailable -> (булево)

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

MultiTenant -> (булево)

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

EngineLifecycleSupport -> (строка)

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

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