Spec-Zone.ru › AWS CLI v2

[ aws . docdb ]

create-db-instance

Описание

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

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

Синтаксис

  create-db-instance
--db-instance-identifier <value>
--db-instance-class <value>
--engine <value>
[--availability-zone <value>]
[--preferred-maintenance-window <value>]
[--auto-minor-version-upgrade | --no-auto-minor-version-upgrade]
[--tags <value>]
--db-cluster-identifier <value>
[--copy-tags-to-snapshot | --no-copy-tags-to-snapshot]
[--promotion-tier <value>]
[--enable-performance-insights | --no-enable-performance-insights]
[--performance-insights-kms-key-id <value>]
[--ca-certificate-identifier <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

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

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

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

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

Пример: mydbinstance

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

Вычислительная и объёмная ёмкость экземпляра; например, db.r5.large.

--engine (строка)

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

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

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

Зона доступности Amazon EC2, в которой создаётся экземпляр.

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

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

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

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

Формат: ddd:hh24:mi-ddd:hh24:mi

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

Допустимые дни: Пн, Вт, Ср, Чт, Пт, Сб, Вс

Ограничения: Минимальная продолжительность интервала - 30 минут.

--auto-minor-version-upgrade | --no-auto-minor-version-upgrade (логическое значение)

Этот параметр не применяется к Amazon DocumentDB. Amazon DocumentDB не выполняет незначительные обновления версии независимо от установленного значения.

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

--tags (список)

Теги, которые должны быть назначены экземпляру. Вы можете назначить до 10 тегов экземпляру.

(структура)

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

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

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

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

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

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

Key=string,Value=string ...

Синтаксис JSON:

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

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

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

--copy-tags-to-snapshot | --no-copy-tags-to-snapshot (логическое значение)

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

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

Значение, указывающее порядок, в котором реплика Amazon DocumentDB повышается до основного экземпляра после сбоя существующего основного экземпляра.

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

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

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

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

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

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

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

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

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

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

Дополнительную информацию см. в разделе Обновление сертификатов TLS Amazon DocumentDB и шифрование данных в процессе передачи в руководстве разработчика Amazon DocumentDB.

--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
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из вашего файла аутентификации.

--region (строка)

Использовать определённый регион. Переопределяет настройки из конфигурации/окружения.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

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

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

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

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

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

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

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться блокирующим образом и не будет ограничено по времени. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

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

Для создания экземпляра кластера Amazon DocumentDB

Следующий create-db-instance пример кода создает экземпляр sample-cluster-instance-2 в кластере Amazon DocumentDB sample-cluster.

aws docdb create-db-instance \
    --db-cluster-identifier sample-cluster \
    --db-instance-classdb.r4.xlarge \
    --db-instance-identifier sample-cluster-instance-2 \
    --engine docdb

Вывод:

{
    "DBInstance": {
        "DBInstanceStatus": "creating",
        "PendingModifiedValues": {
            "PendingCloudwatchLogsExports": {
                "LogTypesToEnable": [
                    "audit"
                ]
            }
        },
        "PubliclyAccessible": false,
        "PreferredBackupWindow": "00:00-00:30",
        "PromotionTier": 1,
        "EngineVersion": "3.6.0",
        "BackupRetentionPeriod": 3,
        "DBInstanceIdentifier": "sample-cluster-instance-2",
        "PreferredMaintenanceWindow": "tue:10:28-tue:10:58",
        "StorageEncrypted": false,
        "Engine": "docdb",
        "DBClusterIdentifier": "sample-cluster",
        "DBSubnetGroup": {
            "Subnets": [
                {
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2a"
                    },
                    "SubnetStatus": "Active",
                    "SubnetIdentifier": "subnet-4e26d263"
                },
                {
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2c"
                    },
                    "SubnetStatus": "Active",
                    "SubnetIdentifier": "subnet-afc329f4"
                },
                {
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2d"
                    },
                    "SubnetStatus": "Active",
                    "SubnetIdentifier": "subnet-53ab3636"
                },
                {
                    "SubnetAvailabilityZone": {
                        "Name": "us-west-2b"
                    },
                    "SubnetStatus": "Active",
                    "SubnetIdentifier": "subnet-991cb8d0"
                }
            ],
            "DBSubnetGroupDescription": "default",
            "SubnetGroupStatus": "Complete",
            "VpcId": "vpc-91280df6",
            "DBSubnetGroupName": "default"
        },
        "DBInstanceClass": "db.r4.xlarge",
        "VpcSecurityGroups": [
            {
                "Status": "active",
                "VpcSecurityGroupId": "sg-77186e0d"
            }
        ],
        "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster-instance-2",
        "DbiResourceId": "db-XEKJLEMGRV5ZKCARUVA4HO3ITE"
    }
}

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

Вывод

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

Подробная информация об экземпляре.

DBInstanceIdentifier -> (строка)

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

DBInstanceClass -> (строка)

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

Engine -> (строка)

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

DBInstanceStatus -> (строка)

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

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

Определяет конечную точку подключения.

Address -> (строка)

Определяет DNS-адрес экземпляра.

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

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

HostedZoneId -> (строка)

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

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

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

PreferredBackupWindow -> (строка)

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

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

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

VpcSecurityGroups -> (список)

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

(структура)

Используется как элемент ответа для запросов о членстве в группе безопасности виртуальной частной сети (VPC).

VpcSecurityGroupId -> (строка)

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

Status -> (строка)

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

AvailabilityZone -> (строка)

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

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

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

DBSubnetGroupName -> (строка)

Имя группы подсетей.

DBSubnetGroupDescription -> (строка)

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

VpcId -> (строка)

Предоставляет идентификатор виртуальной частной сети (VPC) группы подсетей.

SubnetGroupStatus -> (строка)

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

Subnets -> (список)

Подробная информация об одной или нескольких подсетях в группе подсетей.

(структура)

Подробная информация о подсети.

SubnetIdentifier -> (строка)

Указывает идентификатор подсети.

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

Указывает зону доступности для подсети.

Name -> (строка)

Имя зоны доступности.

SubnetStatus -> (строка)

Указывает состояние подсети.

DBSubnetGroupArn -> (строка)

Amazon Resource Name (ARN) для группы подсетей DB.

PreferredMaintenanceWindow -> (строка)

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

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

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

DBInstanceClass -> (строка)

Содержит новое DBInstanceClass для экземпляра, которое будет применено или в настоящее время применяется.

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

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

MasterUserPassword -> (строка)

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

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

Определяет ожидаемый порт для экземпляра.

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

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

MultiAZ -> (булево)

Указывает, что экземпляр Single-AZ должен измениться на развертывание Multi-AZ.

EngineVersion -> (строка)

Указывает версию движка базы данных.

LicenseModel -> (строка)

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

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

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

Определяет новое значение Provisioned IOPS для экземпляра, которое будет применено или в настоящее время применяется.

DBInstanceIdentifier -> (строка)

Содержит новое DBInstanceIdentifier для экземпляра, которое будет применено или в настоящее время применяется.

StorageType -> (строка)

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

CACertificateIdentifier -> (строка)

Указывает идентификатор сертификата центра сертификации (CA) для экземпляра DB.

DBSubnetGroupName -> (строка)

Новая группа подсетей для экземпляра.

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

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

LogTypesToEnable -> (список)

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

(строка)

LogTypesToDisable -> (список)

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

(строка)

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

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

EngineVersion -> (строка)

Указывает версию движка базы данных.

AutoMinorVersionUpgrade -> (булево)

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

PubliclyAccessible -> (булево)

Не поддерживается. Amazon DocumentDB в настоящее время не поддерживает публичные конечные точки. Значение PubliclyAccessible всегда равно false.

StatusInfos -> (список)

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

(структура)

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

StatusType -> (строка)

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

Normal -> (булево)

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

Status -> (строка)

Состояние экземпляра. Для реплики чтения значения могут быть replicating, ошибка, stopped или terminated.

Message -> (строка)

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

DBClusterIdentifier -> (строка)

Содержит имя кластера, членом которого является экземпляр, если экземпляр является членом кластера.

StorageEncrypted -> (булево)

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

KmsKeyId -> (строка)

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

DbiResourceId -> (строка)

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

CACertificateIdentifier -> (строка)

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

CopyTagsToSnapshot -> (булево)

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

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

Значение, указывающее порядок, в котором реплика Amazon DocumentDB повышается до основного экземпляра после отказа существующего основного экземпляра.

DBInstanceArn -> (строка)

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

EnabledCloudwatchLogsExports -> (список)

Список типов логов, которые этот экземпляр настроен на экспорт в CloudWatch Logs.

(строка)

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

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

CAIdentifier -> (строка)

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

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

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

PerformanceInsightsEnabled -> (булево)

Установлено в true, если Amazon RDS Performance Insights включен для экземпляра DB, и в противном случае false.

PerformanceInsightsKMSKeyId -> (строка)

Идентификатор ключа KMS для шифрования данных Performance Insights. Идентификатор ключа KMS — это Amazon Resource Name (ARN), идентификатор ключа KMS или псевдоним ключа KMS для ключа KMS шифрования.

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

Spec-Zone.ru

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