Spec-Zone.ru › AWS CLI v2

[ aws . rds ]

create-db-instance

Описание

Создаёт новый экземпляр базы данных.

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

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

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

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

Синтаксис

  create-db-instance
[--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>]
[--character-set-name <value>]
[--nchar-character-set-name <value>]
[--publicly-accessible | --no-publicly-accessible]
[--tags <value>]
[--db-cluster-identifier <value>]
[--storage-type <value>]
[--tde-credential-arn <value>]
[--tde-credential-password <value>]
[--storage-encrypted | --no-storage-encrypted]
[--kms-key-id <value>]
[--domain <value>]
[--domain-fqdn <value>]
[--domain-ou <value>]
[--domain-auth-secret-arn <value>]
[--domain-dns-ips <value>]
[--copy-tags-to-snapshot | --no-copy-tags-to-snapshot]
[--monitoring-interval <value>]
[--monitoring-role-arn <value>]
[--domain-iam-role-name <value>]
[--promotion-tier <value>]
[--timezone <value>]
[--enable-iam-database-authentication | --no-enable-iam-database-authentication]
[--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>]
[--deletion-protection | --no-deletion-protection]
[--max-allocated-storage <value>]
[--enable-customer-owned-ip | --no-enable-customer-owned-ip]
[--custom-iam-instance-profile <value>]
[--backup-target <value>]
[--network-type <value>]
[--storage-throughput <value>]
[--manage-master-user-password | --no-manage-master-user-password]
[--master-user-secret-kms-key-id <value>]
[--ca-certificate-identifier <value>]
[--db-system-id <value>]
[--dedicated-log-volume | --no-dedicated-log-volume]
[--multi-tenant | --no-multi-tenant]
[--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 (строка)

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

Amazon Aurora MySQL

Имя базы данных, которое будет создано при создании основного экземпляра БД кластера Aurora MySQL. Если этот параметр не указан для кластера Aurora MySQL DB, база данных в кластере не создаётся.

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

  • Должно содержать от 1 до 64 буквенно-цифровых символов.

  • Должно начинаться с буквы. Последующие символы могут быть буквами, символами подчеркивания или цифрами (0-9).

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

    Amazon Aurora PostgreSQL

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

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

  • Должно содержать от 1 до 63 буквенно-цифровых символов.

  • Должно начинаться с буквы. Последующие символы могут быть буквами, символами подчеркивания или цифрами (0-9).

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

    Amazon RDS Custom для Oracle

Идентификатор Oracle системы (SID) создаваемого экземпляра RDS Custom БД. Если вы не укажете значение, по умолчанию будет использовано значение ORCL для не-CDB и RDSCDB для CDB.

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

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

  • Должно содержать от 1 до 8 буквенно-цифровых символов.

  • Должно содержать букву.

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

    Amazon RDS Custom для SQL Server

Не применимо. Должно быть null.

RDS для Db2

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

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

  • Должно содержать от 1 до 64 букв или цифр.

  • Должно начинаться с буквы. Последующие символы могут быть буквами, символами подчеркивания или цифрами (0-9).

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

    RDS для MariaDB

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

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

  • Должно содержать от 1 до 64 букв или цифр.

  • Должно начинаться с буквы. Последующие символы могут быть буквами, символами подчеркивания или цифрами (0-9).

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

    RDS для MySQL

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

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

  • Должно содержать от 1 до 64 букв или цифр.

  • Должно начинаться с буквы. Последующие символы могут быть буквами, символами подчеркивания или цифрами (0-9).

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

    RDS для Oracle

Идентификатор Oracle системы (SID) создаваемого экземпляра БД. Если вы не укажете значение, по умолчанию будет ORCL. Вы не можете указать строку null или любое другое зарезервированное слово для DBName.

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

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

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

    RDS для PostgreSQL

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

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

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

  • Должно начинаться с буквы. Последующие символы могут быть буквами, символами подчеркивания или цифрами (0-9).

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

    RDS для SQL Server

Не применимо. Должно быть null.

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

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

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

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

Пример: mydbinstance

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

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

Это значение не применяется к экземплярам БД Amazon Aurora. Объёмы кластера Aurora автоматически увеличиваются по мере увеличения объёма данных в вашей базе данных, хотя вы платите только за используемое пространство в объёме кластера Aurora.

Amazon RDS Custom

Ограничения объёма памяти для каждого типа хранения:

  • Хранилище общего назначения (SSD) (gp2, gp3): Должно быть целым числом от 40 до 65536 для RDS Custom для Oracle, 16384 для RDS Custom для SQL Server.

  • Хранилище с предварительно заданными IOPS (io1, io2): Должно быть целым числом от 40 до 65536 для RDS Custom для Oracle, 16384 для RDS Custom для SQL Server.

    RDS для Db2

Ограничения объёма памяти для каждого типа хранения:

  • Хранилище общего назначения (SSD) (gp3): Должно быть целым числом от 20 до 65536.

  • Хранилище с предварительно заданными IOPS (io1, io2): Должно быть целым числом от 100 до 65536.

    RDS для MariaDB

Ограничения объёма памяти для каждого типа хранения:

  • Хранилище общего назначения (SSD) (gp2, gp3): Должно быть целым числом от 20 до 65536.

  • Хранилище с предварительно заданными IOPS (io1, io2): Должно быть целым числом от 100 до 65536.

  • Магнитное хранилище (стандартное): Должно быть целым числом от 5 до 3072.

    RDS для MySQL

Ограничения объёма памяти для каждого типа хранения:

  • Хранилище общего назначения (SSD) (gp2, gp3): Должно быть целым числом от 20 до 65536.

  • Хранилище с предварительно заданными IOPS (io1, io2): Должно быть целым числом от 100 до 65536.

  • Магнитное хранилище (стандартное): Должно быть целым числом от 5 до 3072.

    RDS для Oracle

Ограничения объёма памяти для каждого типа хранения:

  • Хранилище общего назначения (SSD) (gp2, gp3): Должно быть целым числом от 20 до 65536.

  • Хранилище с предварительно заданными IOPS (io1, io2): Должно быть целым числом от 100 до 65536.

  • Магнитное хранилище (стандартное): Должно быть целым числом от 10 до 3072.

    RDS для PostgreSQL

Ограничения объёма памяти для каждого типа хранения:

  • Хранилище общего назначения (SSD) (gp2, gp3): Должно быть целым числом от 20 до 65536.

  • Хранилище с предварительно заданными IOPS (io1, io2): Должно быть целым числом от 100 до 65536.

  • Магнитное хранилище (стандартное): Должно быть целым числом от 5 до 3072.

    RDS для SQL Server

Ограничения объёма памяти для каждого типа хранения:

  • Хранилище общего назначения (SSD) (gp2, gp3):
    • Enterprise и Standard редакции: Должно быть целым числом от 20 до 16384.
    • Web и Express редакции: Должно быть целым числом от 20 до 16384.
  • Хранилище с предварительно заданными IOPS (io1, io2):
    • Enterprise и Standard редакции: Должно быть целым числом от 100 до 16384.
    • Web и Express редакции: Должно быть целым числом от 100 до 16384.
  • Магнитное хранилище (стандартное):
    • Enterprise и Standard редакции: Должно быть целым числом от 20 до 1024.
    • Web и Express редакции: Должно быть целым числом от 20 до 1024.

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

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

--engine (строка)

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

Не каждый движок базы данных доступен во всех регионах Amazon Web Services.

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

  • aurora-mysql (для экземпляров БД Aurora MySQL)
  • aurora-postgresql (для экземпляров БД Aurora PostgreSQL)
  • custom-oracle-ee (для экземпляров БД RDS Custom для Oracle)
  • custom-oracle-ee-cdb (для экземпляров БД RDS Custom для Oracle)
  • custom-oracle-se2 (для экземпляров БД RDS Custom для Oracle)
  • custom-oracle-se2-cdb (для экземпляров БД RDS Custom для Oracle)
  • custom-sqlserver-ee (для экземпляров БД RDS Custom для SQL Server)
  • custom-sqlserver-se (для экземпляров БД RDS Custom для SQL Server)
  • custom-sqlserver-web (для экземпляров БД RDS Custom для SQL Server)
  • custom-sqlserver-dev (для экземпляров БД RDS Custom для SQL Server)
  • 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

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

Имя пользователя master.

Это значение не применяется к экземплярам БД Amazon Aurora. Имя пользователя master управляется кластером БД.

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

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

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

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

Пароль для пользователя master.

Это свойство не применяется к экземплярам баз данных Amazon Aurora. Пароль для пользователя master управляется кластером БД.

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

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

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

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

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

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

Это свойство применяется к устаревшей платформе EC2-Classic, которая больше не используется для создания новых экземпляров БД. Используйте свойство VpcSecurityGroupIds вместо этого.

(строка)

Синтаксис:

"string" "string" ...

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

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

Это свойство не применяется к экземплярам баз данных Amazon Aurora. Ассоциированный список групп безопасности EC2 VPC управляется кластером БД.

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

(строка)

Синтаксис:

"string" "string" ...

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

Зона доступности (AZ), в которой будет создана база данных. Сведения о регионах и зонах доступности Amazon Web Services см. в разделе Регионы и зоны доступности .

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

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

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

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

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

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

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

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

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

Пример: mydbsubnetgroup

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

Диапазон времени еженедельно, в течение которого может происходить техническое обслуживание системы. Дополнительные сведения см. в разделе Окно технического обслуживания Amazon RDS в Руководстве пользователя Amazon RDS.

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

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

  • Должно быть в формате ddd:hh24:mi-ddd:hh24:mi .
  • Значения дней должны быть mon | tue | wed | thu | fri | sat | sun .
  • Должно быть в формате всемирного координированного времени (UTC).
  • Не должно конфликтовать с предпочтительным окном резервного копирования.
  • Должно быть не менее 30 минут.

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

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

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

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

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

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

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

Это свойство не применяется к экземплярам баз данных Amazon Aurora. Срок хранения автоматических резервных копий управляется кластером БД.

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

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

  • Должно быть значением от 0 до 35.
  • Не может быть установлено в 0, если экземпляр БД является источником для чтения реплик.
  • Не может быть установлено в 0 для экземпляра RDS Custom для Oracle DB.

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

Ежедневный диапазон времени, в течение которого создаются автоматические резервные копии, если автоматическое резервное копирование включено, используя параметр BackupRetentionPeriod. По умолчанию это 30-минутное окно, случайно выбранное из 8-часового блока времени для каждого региона Amazon Web Services. Дополнительные сведения см. в разделе Окно резервного копирования в Руководстве пользователя Amazon RDS .

Это свойство не применяется к экземплярам баз данных Amazon Aurora. Ежедневный диапазон времени для создания автоматических резервных копий управляется кластером БД.

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

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

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

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

Это свойство не применяется к экземплярам Aurora DB. Номер порта управляется кластером.

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

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

  • RDS for Db2 - 50000
  • RDS for MariaDB - 3306
  • RDS for Microsoft SQL Server - 1433
  • RDS for MySQL - 3306
  • RDS for Oracle - 1521
  • RDS for PostgreSQL - 5432

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

  • Для RDS for Microsoft SQL Server значение не может быть 1234 , 1434 , 3260 , 3343 , 3389 , 47001 или 49152-49156 .

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

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

Это свойство не применяется к следующим экземплярам БД:

  • Amazon Aurora (зоны доступности (AZ) экземпляра БД управляются кластером БД.)
  • RDS Custom

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

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

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

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

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

Amazon RDS Custom для Oracle

Пользовательская версия движка (CEV), которую вы ранее создали. Это свойство необходимо для RDS Custom для Oracle. Имя CEV имеет следующий формат: 19.*customized_string*. Действительное имя CEV - 19.my_cev1. Дополнительные сведения см. в разделе Создание экземпляра БД RDS Custom для Oracle в Руководстве пользователя Amazon RDS .

Amazon RDS Custom для SQL Server

См. общие требования к RDS Custom для SQL Server в Руководстве пользователя Amazon RDS .

RDS for Db2

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

RDS for MariaDB

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

RDS for Microsoft SQL Server

Дополнительные сведения см. в разделе Версии Microsoft SQL Server в Amazon RDS в Руководстве пользователя Amazon RDS .

RDS for MySQL

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

RDS for Oracle

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

RDS for PostgreSQL

Дополнительные сведения см. в разделе Версии и расширения Amazon RDS for PostgreSQL в Руководстве пользователя Amazon RDS .

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

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

Если вы создаете экземпляр RDS Custom DB, вы должны установить AutoMinorVersionUpgrade в значение false .

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

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

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

Примечание

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

По умолчанию для RDS for Db2 - bring-your-own-license .

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

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

  • 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

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

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

Это свойство не применяется к экземплярам баз данных Amazon Aurora. Хранилище управляется кластером БД.

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

  • Для RDS for Db2, MariaDB, MySQL, Oracle и PostgreSQL - должно быть кратно от 0,5 до 50 хранилища для экземпляра БД.
  • Для RDS for SQL Server - должно быть кратно от 1 до 50 хранилища для экземпляра БД.

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

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

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

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

--character-set-name (строка)

Для поддерживаемых движков, кодировка символов (CharacterSet ) для ассоциации с экземпляром БД.

Это значение не применяется к следующим экземплярам БД:

  • Amazon Aurora — кодировка символов управляется кластером БД. Дополнительную информацию см. в CreateDBCluster .
  • RDS Custom — однако, если вам нужно изменить кодировку символов, вы можете изменить её непосредственно в базе данных.

--nchar-character-set-name (строка)

Имя кодировки символов NCHAR для экземпляра БД Oracle.

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

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

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

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

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

По умолчанию: поведение по умолчанию зависит от того, указан ли DBSubnetGroupName.

Если DBSubnetGroupName не указан, и PubliclyAccessible не указан, применяется следующее:

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

Если DBSubnetGroupName указан, и PubliclyAccessible не указан, применяется следующее:

  • Если подсети являются частью VPC, к которой не подключен интернет-шлюз, экземпляр БД является частным.
  • Если подсети являются частью VPC, к которой подключен интернет-шлюз, экземпляр БД является публичным.

--tags (список)

Теги для назначения экземпляру БД.

(структура)

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

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

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

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

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

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

Краткая синтаксическая запись:

Key=string,Value=string ...

Синтаксис JSON:

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

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

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

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

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

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

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

Это значение не применяется к экземплярам БД Amazon Aurora. Хранилище управляется кластером БД.

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

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

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

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

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

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

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

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

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

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

Для экземпляров RDS Custom БД включите это значение или оставьте его без изменений. В противном случае Amazon RDS сообщит об ошибке.

Это значение не применяется к экземплярам БД Amazon Aurora. Шифрование экземпляров БД управляется кластером БД.

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

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

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

Это значение не применяется к экземплярам БД Amazon Aurora. Идентификатор ключа Amazon Web Services KMS управляется кластером БД. Дополнительную информацию см. в CreateDBCluster.

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

Для Amazon RDS Custom ключ KMS необходим для экземпляров БД. Для большинства движков RDS, если вы оставите этот параметр пустым при включении StorageEncrypted, движок использует ключ KMS по умолчанию. Однако RDS Custom не использует ключ по умолчанию, когда этот параметр пуст. Вам необходимо явно указать ключ.

--domain (строка)

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

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

Это значение не применяется к следующим экземплярам БД:

  • Amazon Aurora (домен управляется кластером БД.)
  • 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 с учетными данными для пользователя, присоединяющегося к домену.

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

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

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

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

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

Пример: 123.124.125.126,234.235.236.237

(строка)

Синтаксис:

"string" "string" ...

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

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

Это значение не применяется к экземплярам БД Amazon Aurora. Копирование тегов в снимки управляется кластером БД. Установка этого значения для экземпляра БД Aurora не влияет на настройку кластера БД.

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

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

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

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

Допустимые значения: 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.

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

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

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

Это значение не применяется к следующим экземплярам БД:

  • Amazon Aurora (домен управляется кластером БД.)
  • RDS Custom

--promotion-tier (целое число)

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

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

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

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

--timezone (строка)

Часовой пояс экземпляра БД. Параметр часового пояса в настоящее время поддерживается только RDS для Db2 и RDS для SQL Server.

--enable-iam-database-authentication | --no-enable-iam-database-authentication (булево)

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

Дополнительную информацию см. в разделе IAM-аутентификация для MySQL и PostgreSQL в Руководстве пользователя Amazon RDS.

Это значение не применяется к следующим экземплярам БД:

  • Amazon Aurora (отображение учетных записей Amazon Web Services IAM в учетные записи баз данных управляется кластером БД.)
  • RDS Custom

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

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

Примечание

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

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

  • standard
  • advanced

--enable-performance-insights | --no-enable-performance-insights (boolean)

Указывает, следует ли включить Performance Insights для экземпляра БД. Дополнительную информацию см. в разделе Использование Amazon Performance Insights в руководстве пользователя Amazon RDS .

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

--performance-insights-kms-key-id (string)

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

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

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

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

--performance-insights-retention-period (integer)

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

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

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

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

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

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

--enable-cloudwatch-logs-exports (list)

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

Это значение не применяется к следующим экземплярам БД:

  • Amazon Aurora (экспорт CloudWatch Logs обрабатывается кластером БД.)
  • RDS Custom

Следующие значения допустимы для каждого движка БД:

  • RDS for Db2 - diag.log | notify.log | iam-db-auth-error
  • RDS for MariaDB - audit | error | general | slowquery | iam-db-auth-error
  • RDS for Microsoft SQL Server - agent | error
  • RDS for MySQL - audit | error | general | slowquery | iam-db-auth-error
  • RDS for Oracle - alert | audit | listener | trace | oemagent
  • RDS for PostgreSQL - postgresql | upgrade | iam-db-auth-error

(string)

Синтаксис:

"string" "string" ...

--processor-features (list)

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

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

(структура)

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

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

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

  • CreateDBInstance
  • ModifyDBInstance
  • RestoreDBInstanceFromDBSnapshot
  • RestoreDBInstanceFromS3
  • RestoreDBInstanceToPointInTime

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

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

  • DescribeDBInstances
  • DescribeDBSnapshots
  • DescribeValidDBInstanceModifications

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

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

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

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

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

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

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

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

Name=string,Value=string ...

Синтаксис JSON:

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

--deletion-protection | --no-deletion-protection (boolean)

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

Это значение не применяется к экземплярам БД Amazon Aurora. Вы можете включить или отключить защиту от удаления для кластера БД. Дополнительную информацию см. в CreateDBCluster . Экземпляры БД в кластере БД могут быть удалены, даже если защита от удаления включена для кластера БД.

--max-allocated-storage (integer)

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

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

Это значение не применяется к следующим экземплярам БД:

  • Amazon Aurora (хранилище управляется кластером БД.)
  • RDS Custom

--enable-customer-owned-ip | --no-enable-customer-owned-ip (boolean)

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

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

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

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

--custom-iam-instance-profile (string)

Профиль экземпляра, связанный с базовым экземпляром Amazon EC2 для экземпляра RDS Custom DB.

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

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

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

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

--backup-target (string)

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

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

  • outposts (Amazon Web Services Outposts)
  • region (область Amazon Web Services)

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

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

--network-type (string)

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

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

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

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

--storage-throughput (integer)

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

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

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

--manage-master-user-password | --no-manage-master-user-password (boolean)

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

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

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

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

--master-user-secret-kms-key-id (string)

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

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

Идентификатор ключа KMS Amazon Web Services — это 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 есть свой ключ KMS по умолчанию для каждой области Amazon Web Services.

--ca-certificate-identifier (string)

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

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

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

--db-system-id (string)

Идентификатор системы Oracle (SID), который является именем экземпляра базы данных Oracle, управляющего файлами вашей базы данных. В этом контексте термин «экземпляр базы данных Oracle» относится исключительно к глобальной области системы (SGA) и фоновым процессам Oracle. Если вы не укажете SID, значение по умолчанию — RDSCDB. SID Oracle также является именем вашей CDB.

--dedicated-log-volume | --no-dedicated-log-volume (boolean)

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

--multi-tenant | --no-multi-tenant (boolean)

Указывает, использовать ли многоарендаторную конфигурацию или одноарендаторную конфигурацию (по умолчанию). Этот параметр применим только к движкам баз данных Oracle контейнерных баз данных (CDB) RDS.

Обратите внимание на следующие ограничения:

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

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

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

Примечание

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

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

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

Допустимые значения: 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 (строка)

Включить/выключить вывод в цвете.

  • включено
  • выключено
  • автоматически

--no-sign-request (логическое значение)

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

--ca-bundle (строка)

Файл сертификатов CA для использования при проверке SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--ca-bundle (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 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 в руководстве пользователя AWS CLI.

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

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

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

aws rds create-db-instance \
    --db-instance-identifier test-mysql-instance \
    --db-instance-classdb.t3.micro \
    --engine mysql \
    --master-username admin \
    --master-user-password secret99 \
    --allocated-storage 20

Вывод:

{
    "DBInstance": {
        "DBInstanceIdentifier": "test-mysql-instance",
        "DBInstanceClass": "db.t3.micro",
        "Engine": "mysql",
        "DBInstanceStatus": "creating",
        "MasterUsername": "admin",
        "AllocatedStorage": 20,
        "PreferredBackupWindow": "12:55-13:25",
        "BackupRetentionPeriod": 1,
        "DBSecurityGroups": [],
        "VpcSecurityGroups": [
            {
                "VpcSecurityGroupId": "sg-12345abc",
                "Status": "active"
            }
        ],
        "DBParameterGroups": [
            {
                "DBParameterGroupName": "default.mysql5.7",
                "ParameterApplyStatus": "in-sync"
            }
        ],
        "DBSubnetGroup": {
            "DBSubnetGroupName": "default",
            "DBSubnetGroupDescription": "default",
            "VpcId": "vpc-2ff2ff2f",
            "SubnetGroupStatus": "Complete",
            "Subnets": [
                {
                    "SubnetIdentifier": "subnet-########",
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2c"
                    },
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-########",
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2d"
                    },
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-########",
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2a"
                    },
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-########",
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2b"
                    },
                    "SubnetStatus": "Active"
                }
            ]
        },
        "PreferredMaintenanceWindow": "sun:08:07-sun:08:37",
        "PendingModifiedValues": {
            "MasterUserPassword": "****"
        },
        "MultiAZ": false,
        "EngineVersion": "5.7.22",
        "AutoMinorVersionUpgrade": true,
        "ReadReplicaDBInstanceIdentifiers": [],
        "LicenseModel": "general-public-license",
        "OptionGroupMemberships": [
            {
                "OptionGroupName": "default:mysql-5-7",
                "Status": "in-sync"
            }
        ],
        "PubliclyAccessible": true,
        "StorageType": "gp2",
        "DbInstancePort": 0,
        "StorageEncrypted": false,
        "DbiResourceId": "db-5555EXAMPLE44444444EXAMPLE",
        "CACertificateIdentifier": "rds-ca-2019",
        "DomainMemberships": [],
        "CopyTagsToSnapshot": false,
        "MonitoringInterval": 0,
        "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:test-mysql-instance",
        "IAMDatabaseAuthenticationEnabled": false,
        "PerformanceInsightsEnabled": false,
        "DeletionProtection": false,
        "AssociatedRoles": []
    }
}

Дополнительную информацию см. в разделе Создание экземпляра базы данных Amazon RDS в руководстве пользователя 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 for Oracle CDB имя идентифицирует PDB, а не CDB.

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

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

Примечание

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

Address -> (строка)

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

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

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

HostedZoneId -> (строка)

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

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

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

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

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

PreferredBackupWindow -> (строка)

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

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

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

DBSecurityGroups -> (список)

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

(структура)

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

  • ModifyDBInstance
  • RebootDBInstance
  • RestoreDBInstanceFromDBSnapshot
  • RestoreDBInstanceToPointInTime

DBSecurityGroupName -> (строка)

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

Status -> (строка)

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

VpcSecurityGroups -> (список)

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

(структура)

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

VpcSecurityGroupId -> (строка)

Название группы безопасности VPC.

Status -> (строка)

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

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

DBParameterGroups -> (список)

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

(структура)

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

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

  • CreateDBInstance
  • CreateDBInstanceReadReplica
  • DeleteDBInstance
  • ModifyDBInstance
  • RebootDBInstance
  • RestoreDBInstanceFromDBSnapshot

DBParameterGroupName -> (строка)

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

ParameterApplyStatus -> (строка)

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

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

AvailabilityZone -> (строка)

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

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

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

DBSubnetGroupName -> (строка)

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

DBSubnetGroupDescription -> (строка)

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

VpcId -> (строка)

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

SubnetGroupStatus -> (строка)

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

Subnets -> (список)

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

(структура)

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

SubnetIdentifier -> (строка)

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

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

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

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

Name -> (строка)

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

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

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

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

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

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

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 экземплярам БД.

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

Указывает, работает ли экземпляр нормально (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 ключа, идентификатор ключа, ARN псевдонима или имя псевдонима для ключа KMS.

DbiResourceId -> (строка)

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

CACertificateIdentifier -> (string)

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

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

DomainMemberships -> (list)

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

(структура)

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

Domain -> (string)

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

Status -> (string)

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

FQDN -> (string)

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

IAMRoleName -> (string)

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

OU -> (string)

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

AuthSecretArn -> (string)

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

DnsIps -> (list)

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

(string)

CopyTagsToSnapshot -> (boolean)

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

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

MonitoringInterval -> (integer)

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

EnhancedMonitoringResourceArn -> (string)

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

MonitoringRoleArn -> (string)

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

PromotionTier -> (integer)

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

DBInstanceArn -> (string)

Идентификатор ресурса Amazon Resource Name (ARN) для экземпляра базы данных.

Timezone -> (string)

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

IAMDatabaseAuthenticationEnabled -> (boolean)

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

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

DatabaseInsightsMode -> (string)

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

PerformanceInsightsEnabled -> (boolean)

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

PerformanceInsightsKMSKeyId -> (string)

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

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

PerformanceInsightsRetentionPeriod -> (integer)

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

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

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

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

EnabledCloudwatchLogsExports -> (list)

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

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

(string)

ProcessorFeatures -> (list)

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

(структура)

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

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

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

  • CreateDBInstance
  • ModifyDBInstance
  • RestoreDBInstanceFromDBSnapshot
  • RestoreDBInstanceFromS3
  • RestoreDBInstanceToPointInTime

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

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

  • DescribeDBInstances
  • DescribeDBSnapshots
  • DescribeValidDBInstanceModifications

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

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

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

Name -> (string)

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

Value -> (string)

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

DeletionProtection -> (boolean)

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

AssociatedRoles -> (list)

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

(структура)

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

RoleArn -> (string)

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

FeatureName -> (string)

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

Status -> (string)

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

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

ListenerEndpoint -> (structure)

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

Address -> (string)

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

Port -> (integer)

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

HostedZoneId -> (string)

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

MaxAllocatedStorage -> (integer)

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

TagList -> (list)

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

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

(структура)

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

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

Key -> (string)

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

Value -> (string)

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

DBInstanceAutomatedBackupsReplications -> (list)

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

(структура)

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

DBInstanceAutomatedBackupsArn -> (string)

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

CustomerOwnedIpEnabled -> (boolean)

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

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

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

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

AwsBackupRecoveryPointArn -> (строка)

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

ActivityStreamStatus -> (строка)

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

ActivityStreamKmsKeyId -> (строка)

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

ActivityStreamKinesisStreamName -> (строка)

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

ActivityStreamMode -> (строка)

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

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

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

AutomationMode -> (строка)

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

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

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

CustomIamInstanceProfile -> (строка)

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

  • Профиль должен существовать в вашем аккаунте.
  • Профиль должен иметь роль 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» и руководстве пользователя Amazon Aurora в разделе «Работа с экземпляром базы данных в VPC».

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

ActivityStreamPolicyStatus -> (строка)

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

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

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

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

DBSystemId -> (строка)

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

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

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

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

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