Spec-Zone.ru › AWS CLI v2

[ aws . rds ]

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

Описание

Amazon Relational Database Service (Amazon RDS) поддерживает импорт баз данных MySQL с использованием файлов резервных копий. Вы можете создать резервную копию вашей локальной базы данных, сохранить её на Amazon Simple Storage Service (Amazon S3), а затем восстановить файл резервной копии на новый экземпляр Amazon RDS DB, работающий под MySQL. Для получения дополнительной информации см. раздел Импорт данных в экземпляр Amazon RDS MySQL DB в Руководстве пользователя Amazon RDS.

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

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

Синопсис

  restore-db-instance-from-s3
[--db-name <value>]
--db-instance-identifier <value>
[--allocated-storage <value>]
--db-instance-class <value>
--engine <value>
[--master-username <value>]
[--master-user-password <value>]
[--db-security-groups <value>]
[--vpc-security-group-ids <value>]
[--availability-zone <value>]
[--db-subnet-group-name <value>]
[--preferred-maintenance-window <value>]
[--db-parameter-group-name <value>]
[--backup-retention-period <value>]
[--preferred-backup-window <value>]
[--port <value>]
[--multi-az | --no-multi-az]
[--engine-version <value>]
[--auto-minor-version-upgrade | --no-auto-minor-version-upgrade]
[--license-model <value>]
[--iops <value>]
[--option-group-name <value>]
[--publicly-accessible | --no-publicly-accessible]
[--tags <value>]
[--storage-type <value>]
[--storage-encrypted | --no-storage-encrypted]
[--kms-key-id <value>]
[--copy-tags-to-snapshot | --no-copy-tags-to-snapshot]
[--monitoring-interval <value>]
[--monitoring-role-arn <value>]
[--enable-iam-database-authentication | --no-enable-iam-database-authentication]
--source-engine <value>
--source-engine-version <value>
--s3-bucket-name <value>
[--s3-prefix <value>]
--s3-ingestion-role-arn <value>
[--database-insights-mode <value>]
[--enable-performance-insights | --no-enable-performance-insights]
[--performance-insights-kms-key-id <value>]
[--performance-insights-retention-period <value>]
[--enable-cloudwatch-logs-exports <value>]
[--processor-features <value>]
[--use-default-processor-features | --no-use-default-processor-features]
[--deletion-protection | --no-deletion-protection]
[--max-allocated-storage <value>]
[--network-type <value>]
[--storage-throughput <value>]
[--manage-master-user-password | --no-manage-master-user-password]
[--master-user-secret-kms-key-id <value>]
[--dedicated-log-volume | --no-dedicated-log-volume]
[--ca-certificate-identifier <value>]
[--engine-lifecycle-support <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-name (строка)

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

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

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

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

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

Пример: mydbinstance

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

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

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

Примечание

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

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

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

Импорт из Amazon S3 не поддерживается для класса экземпляра БД db.t2.micro.

--engine (строка)

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

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

--master-username (строка)

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

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

  • Должен содержать от 1 до 16 букв или цифр.
  • Первый символ должен быть буквой.
  • Не должен совпадать с зарезервированным словом для выбранного движка БД.

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

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

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

  • Не может быть указан, если ManageMasterUserPassword включен.
  • Может содержать любые печатные символы ASCII, кроме «/», «”», или «@». Для RDS для Oracle, не может включать символ «&» (амперсанд) или «'» (одинарную кавычку).

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

  • RDS для Db2 - Должно содержать от 8 до 128 символов.
  • RDS для MariaDB - Должно содержать от 8 до 41 символа.
  • RDS для Microsoft SQL Server - Должно содержать от 8 до 128 символов.
  • RDS для MySQL - Должно содержать от 8 до 41 символа.
  • RDS для Oracle - Должно содержать от 8 до 30 символов.
  • RDS для PostgreSQL - Должно содержать от 8 до 128 символов.

--db-security-groups (список)

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

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

(строка)

Синтаксис:

"string" "string" ...

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

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

(строка)

Синтаксис:

"string" "string" ...

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

Зона доступности, в которой создается экземпляр БД. Сведения о регионах и зонах доступности Amazon Web Services см. в Руководстве пользователя Amazon RDS в разделе «Регионы и зоны доступности».

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

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

Ограничение: параметр AvailabilityZone нельзя указать, если экземпляр БД является многозонным. Указанная зона доступности должна находиться в том же регионе Amazon Web Services, что и текущая конечная точка.

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

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

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

Пример: mydbsubnetgroup

--preferred-maintenance-window (строка)

Интервал времени в неделю, когда может происходить техническое обслуживание системы, в формате всемирного координированного времени (UTC). Дополнительную информацию см. в Руководстве пользователя Amazon RDS в разделе «Окно технического обслуживания Amazon RDS».

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

  • Должен быть в формате ddd:hh24:mi-ddd:hh24:mi.
  • Допустимые дни: Пн, Вт, Ср, Чт, Пт, Сб, Вс.
  • Должен быть в формате всемирного координированного времени (UTC).
  • Не должен конфликтовать с предпочтительным окном резервного копирования.
  • Должен быть не менее 30 минут.

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

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

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

--backup-retention-period (целое число)

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

--preferred-backup-window (строка)

Интервал времени каждый день, в течение которого создаются автоматические резервные копии, если резервное копирование включено. Дополнительную информацию см. в Руководстве пользователя Amazon RDS в разделе «Окно резервного копирования».

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

  • Должен быть в формате hh24:mi-hh24:mi.
  • Должен быть в формате всемирного координированного времени (UTC).
  • Не должен конфликтовать с предпочтительным окном технического обслуживания.
  • Должен быть не менее 30 минут.

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

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

Тип: Целое число

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

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

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

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

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

Номер версии движка БД. Выберите последнюю версию вашего движка БД. Сведения о версиях движков см. в CreateDBInstance, или вызовите DescribeDBEngineVersions.

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

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

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

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

Модель лицензии для этого экземпляра БД. Используйте general-public-license.

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

Количество Provisioned IOPS (операций ввода/вывода в секунду) для начального выделения для экземпляра БД. Сведения о допустимых значениях IOPS см. в Руководстве пользователя Amazon RDS в разделе «Хранилище Amazon RDS с Provisioned IOPS».

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

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

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

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

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

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

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

--tags (список)

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

(структура)

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

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

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

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

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

Значение — это необязательное значение тега. Строковое значение может быть от 1 до 256 символов Unicode и не может начинаться с aws: или rds:. Строка может содержать только набор символов Unicode, цифр, пробелов, «_», «.», «:», «/», «=», «+», «-», «@» (Java regex: “^([\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; в противном случае gp2

--storage-encrypted | --no-storage-encrypted (булево)

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

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

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

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

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

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

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

--monitoring-interval (целое число)

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

Если указан MonitoringRoleArn, то вы также должны установить MonitoringInterval в значение, отличное от 0.

Допустимые значения: 0, 1, 5, 10, 15, 30, 60

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

--monitoring-role-arn (строка)

ARN для роли IAM, разрешающей RDS отправлять расширенные метрики мониторинга в Amazon CloudWatch Logs. Например, arn:aws:iam:123456789012:role/emaccess. Для получения информации о создании роли мониторинга, см. Настройка и включение расширенного мониторинга в руководстве пользователя Amazon RDS.

Если MonitoringInterval установлено значением, отличным от 0, то вы должны указать значение MonitoringRoleArn.

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

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

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

--source-engine (строка)

Имя движка вашей исходной базы данных.

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

--source-engine-version (строка)

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

Поддерживаются версии MySQL 5.6 и 5.7.

Пример: 5.6.40

--s3-bucket-name (строка)

Имя вашего ведра Amazon S3, содержащего файл резервной копии базы данных.

--s3-prefix (строка)

Префикс вашего ведра Amazon S3.

--s3-ingestion-role-arn (строка)

Роль управления доступом и идентификацией Amazon Web Services (IAM) с политикой доверия и политикой разрешений, позволяющей Amazon RDS получать доступ к вашему ведру Amazon S3. Для получения информации об этой роли см. Создание роли IAM вручную в руководстве пользователя Amazon RDS.

--database-insights-mode (строка)

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

Примечание

Экземпляры Aurora DB наследуют это значение от кластера DB, поэтому вы не можете изменить это значение.

Возможные значения:

  • standard
  • advanced

--enable-performance-insights | --no-enable-performance-insights (логическое)

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

Дополнительная информация в разделе Использование Amazon Performance Insights в руководстве пользователя Amazon RDS.

--performance-insights-kms-key-id (строка)

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

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

Если вы не укажете значение для PerformanceInsightsKMSKeyId, Amazon RDS использует ваш ключ KMS по умолчанию. Для вашей учетной записи Amazon Web Services есть ключ KMS по умолчанию для каждой области Amazon Web Services.

--performance-insights-retention-period (целое число)

Количество дней для сохранения данных Performance Insights. По умолчанию — 7 дней. Допустимые значения:

  • 7
  • месяц * 31, где месяц — число месяцев от 1 до 23
  • 731

Например, следующие значения допустимы:

  • 93 (3 месяца * 31)
  • 341 (11 месяцев * 31)
  • 589 (19 месяцев * 31)
  • 731

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

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

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

(строка)

Синтаксис:

"string" "string" ...

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

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

(структура)

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

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

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

  • CreateDBInstance
  • ModifyDBInstance
  • RestoreDBInstanceFromDBSnapshot
  • RestoreDBInstanceFromS3
  • RestoreDBInstanceToPointInTime

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

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

  • DescribeDBInstances
  • DescribeDBSnapshots
  • DescribeValidDBInstanceModifications

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

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

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

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

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

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

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

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

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

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

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

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

  • IPV4
  • DUAL

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

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

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

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

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

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

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

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

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

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

--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 ключа, ID ключа, 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.

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

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

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

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

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

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

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

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

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

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

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

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

Следующий restore-db-instance-from-s3 пример создает новый экземпляр базы данных под названием restored-test-instance из существующей резервной копии в ведре my-backups S3.

aws rds restore-db-instance-from-s3 \
    --db-instance-identifier restored-test-instance \
    --allocated-storage 250 --db-instance-classdb.m4.large --engine mysql \
    --master-username master --master-user-password secret99 \
    --s3-bucket-name my-backups --s3-ingestion-role-arn arn:aws:iam::123456789012:role/my-role \
    --source-engine mysql --source-engine-version 5.6.27

Вывод

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 -> (булево)

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

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 -> (булево)

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

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

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

MultiAZ -> (булево)

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

EngineVersion -> (строка)

Версия движка базы данных.

AutoMinorVersionUpgrade -> (булево)

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

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

ReadReplicaSourceDBInstanceIdentifier -> (строка)

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

ReadReplicaDBInstanceIdentifiers -> (список)

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

(строка)

ReadReplicaDBClusterIdentifiers -> (список)

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

Примечание

В настоящее время каждый экземпляр базы данных RDS может иметь только одну реплику чтения 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 -> (строка)

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

PubliclyAccessible -> (булево)

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

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

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

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

StatusInfos -> (список)

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

(структура)

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

StatusType -> (строка)

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

Normal -> (булево)

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

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 ключа, идентификатор ключа, 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 секрета Secrets Manager с учетными данными пользователя, являющегося членом домена.

DnsIps -> (список)

IP-адреса IPv4 DNS первичных и вторичных контроллеров домена 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 для Db2 и RDS для SQL Server, созданных со спецификацией часового пояса.

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

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

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

DatabaseInsightsMode -> (строка)

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

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

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

PerformanceInsightsKMSKeyId -> (строка)

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

Идентификатор ключа шифрования Amazon Web Services KMS — это ARN ключа, идентификатор ключа, 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 -> (список)

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

(структура)

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

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

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

  • CreateDBInstance
  • ModifyDBInstance
  • RestoreDBInstanceFromDBSnapshot
  • RestoreDBInstanceFromS3
  • RestoreDBInstanceToPointInTime

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

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

  • DescribeDBInstances
  • DescribeDBSnapshots
  • DescribeValidDBInstanceModifications

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

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

Дополнительную информацию см. в разделе Настройка процессора для класса экземпляра базы данных в 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 -> (строка)

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

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

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

TagList -> (список)

Список меток.

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

(структура)

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

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

Key -> (строка)

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

Value -> (строка)

Значение — это необязательное значение метки. Значение строки может иметь длину от 1 до 256 символов Юникода и не может начинаться с aws: или rds:. Строка может содержать только набор символов Юникода, цифр, пробелов, «_», «.», «:», «/», «=», «+», «-», «@» (Java regex: “^([\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 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: 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, см. в разделе Настройка 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.

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

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

Дополнительную информацию см. в разделе Управление паролями с помощью 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.

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

Spec-Zone.ru

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