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

Описание

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

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

Синтаксис

  modify-db-cluster
--db-cluster-identifier <value>
[--new-db-cluster-identifier <value>]
[--apply-immediately | --no-apply-immediately]
[--backup-retention-period <value>]
[--db-cluster-parameter-group-name <value>]
[--vpc-security-group-ids <value>]
[--port <value>]
[--master-user-password <value>]
[--option-group-name <value>]
[--preferred-backup-window <value>]
[--preferred-maintenance-window <value>]
[--enable-iam-database-authentication | --no-enable-iam-database-authentication]
[--cloudwatch-logs-export-configuration <value>]
[--engine-version <value>]
[--allow-major-version-upgrade | --no-allow-major-version-upgrade]
[--db-instance-parameter-group-name <value>]
[--deletion-protection | --no-deletion-protection]
[--copy-tags-to-snapshot | --no-copy-tags-to-snapshot]
[--serverless-v2-scaling-configuration <value>]
[--storage-type <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-cluster-identifier (строка)

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

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

Должен соответствовать идентификатору существующего DBCluster.

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

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

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

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

Пример: my-cluster2

--apply-immediately | --no-apply-immediately (логическое)

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

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

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

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

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

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

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

Должно быть значением от 1 до 35

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

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

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

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

(строка)

Синтаксис:

"string" "string" ...

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

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

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

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

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

Не поддерживается Neptune.

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

Не поддерживается Neptune.

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

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

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

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

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

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

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

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

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

Действительные дни: Пн, Вт, Ср, Чт, Пт, Сб, Вс.

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

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

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

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

--cloudwatch-logs-export-configuration (структура)

Настройка параметров протоколирования типов журналов, которые должны быть включены для экспорта в CloudWatch Logs для конкретного кластера баз данных. См. Использование командной строки для публикации аудиторских журналов Neptune в CloudWatch Logs.

EnableLogTypes -> (список)

Список типов журналов для включения.

(строка)

DisableLogTypes -> (список)

Список типов журналов для отключения.

(строка)

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

EnableLogTypes=string,string,DisableLogTypes=string,string

JSON-синтаксис:

{
  "EnableLogTypes": ["string", ...],
  "DisableLogTypes": ["string", ...]
}

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

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

Список допустимых версий движка см. в статье Релизы движка Amazon Neptune или вызовите DescribeDBEngineVersions.

--allow-major-version-upgrade | --no-allow-major-version-upgrade (логическое)

Значение, указывающее, разрешены ли обновления между разными основными версиями.

Ограничения: Необходимо установить флаг allow-major-version-upgrade при указании параметра EngineVersion, который использует другую основную версию, чем текущая версия кластера баз данных.

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

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

Примечание

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

По умолчанию: текущее имя.

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

Группа параметров базы данных должна принадлежать тому же семейству группы параметров базы данных, что и целевая версия кластера баз данных.
Параметр DBInstanceParameterGroupName действителен только в сочетании с параметром AllowMajorVersionUpgrade.

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

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

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

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

--serverless-v2-scaling-configuration (структура)

Содержит конфигурацию масштабирования кластера баз данных Neptune Serverless.

Дополнительные сведения см. в руководстве по Amazon Neptune Serverless.

MinCapacity -> (двойное)

Минимальное количество единиц емкости Neptune (NCU) для экземпляра базы данных в кластере Neptune Serverless. Вы можете указать значения NCU с шагом в половину, такие как 8, 8,5, 9 и т. д.

MaxCapacity -> (двойное)

Максимальное количество единиц емкости Neptune (NCU) для экземпляра базы данных в кластере Neptune Serverless. Вы можете указать значения NCU с шагом в половину, такие как 40, 40,5, 41 и т. д.

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

MinCapacity=double,MaxCapacity=double

JSON-синтаксис:

{
  "MinCapacity": double,
  "MaxCapacity": double
}

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

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

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

**standard ** – ( по умолчанию ) Настраивает экономичное хранилище базы данных для приложений со средним или небольшим использованием ввода/вывода.
**iopt1 ** – Включает хранилище с оптимизацией ввода/вывода, разработанное для удовлетворения потребностей интенсивно используемых графовых рабочих нагрузок, которые требуют прогнозируемой стоимости с низкой задержкой ввода/вывода и постоянной пропускной способностью ввода/вывода. Хранилище Neptune с оптимизацией ввода/вывода доступно только начиная с версии движка 1.3.0.0.

--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 (boolean)

Включить отладку логирования.

--endpoint-url (string)

Переопределить URL по умолчанию команды указанным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команд.

json
text
table
yaml
yaml-stream

--query (string)

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

--profile (string)

Использовать определенный профиль из файла учетных данных.

--region (string)

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

--version (string)

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

--color (string)

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

on
off
auto

--no-sign-request (boolean)

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

--ca-bundle (string)

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

--cli-read-timeout (int)

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

--cli-connect-timeout (int)

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

--cli-binary-format (string)

Стиль форматирования для двоичных блоков. Формат по умолчанию — 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 (boolean)

Отключить кли-страничник для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

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

Содержит сведения об Amazon Neptune кластере БД.

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

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

AllocatedStorage всегда возвращает 1, потому что размер хранилища кластера БД Neptune не фиксирован, а автоматически настраивается по мере необходимости.

AvailabilityZones -> (список)

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

(строка)

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

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

CharacterSetName -> (строка)

Не поддерживается Neptune.

DatabaseName -> (строка)

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

DBClusterIdentifier -> (строка)

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

DBClusterParameterGroup -> (строка)

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

DBSubnetGroup -> (строка)

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

Status -> (строка)

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

PercentProgress -> (строка)

Указывает процент выполнения операции.

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

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

Endpoint -> (строка)

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

ReaderEndpoint -> (строка)

Конечная точка чтения для кластера БД. Конечная точка чтения для кластера БД балансирует подключения через доступные в кластере БД реплики чтения. По мере того, как клиенты запрашивают новые подключения к конечной точке чтения, Neptune распределяет запросы подключений между репликами чтения в кластере БД. Эта функция может помочь сбалансировать вашу рабочую нагрузку чтения между несколькими репликами чтения в вашем кластере БД.

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

MultiAZ -> (булево)

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

Engine -> (строка)

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

EngineVersion -> (строка)

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

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

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

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

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

MasterUsername -> (строка)

Не поддерживается Neptune.

DBClusterOptionGroupMemberships -> (список)

Не поддерживается Neptune.

(структура)

Не поддерживается Neptune.

DBClusterOptionGroupName -> (строка)

Не поддерживается Neptune.

Status -> (строка)

Не поддерживается Neptune.

PreferredBackupWindow -> (строка)

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

PreferredMaintenanceWindow -> (строка)

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

ReplicationSourceIdentifier -> (строка)

Не поддерживается Neptune.

ReadReplicaIdentifiers -> (список)

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

(строка)

DBClusterMembers -> (список)

Предоставляет список экземпляров, составляющих кластер БД.

(структура)

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

DBInstanceIdentifier -> (строка)

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

IsClusterWriter -> (булево)

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

DBClusterParameterGroupStatus -> (строка)

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

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

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

VpcSecurityGroups -> (список)

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

(структура)

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

VpcSecurityGroupId -> (строка)

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

Status -> (строка)

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

HostedZoneId -> (строка)

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

StorageEncrypted -> (булево)

Указывает, зашифрован ли кластер БД.

KmsKeyId -> (строка)

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

DbClusterResourceId -> (строка)

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

DBClusterArn -> (строка)

Amazon Resource Name (ARN) для кластера БД.

AssociatedRoles -> (список)

Предоставляет список ролей управления доступом и идентификацией Amazon (IAM), связанных с кластером БД. Роли IAM, связанные с кластером БД, предоставляют разрешение для доступа к другим службам Amazon от имени вашего кластера БД.

(структура)

Описывает роль управления доступом и идентификацией Amazon (IAM), связанную с кластером БД.

RoleArn -> (строка)

Amazon Resource Name (ARN) роли IAM, связанной с кластером БД.

Status -> (строка)

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

ACTIVE - ARN роли IAM связан с кластером БД и может использоваться для доступа к другим службам Amazon от вашего имени.
PENDING - ARN роли IAM связывается с кластером БД.
INVALID - ARN роли IAM связан с кластером БД, но кластер БД не может принять роль IAM, чтобы получить доступ к другим службам Amazon от вашего имени.

FeatureName -> (строка)

Имя функции, связанной с ролью управления доступом и идентификацией Amazon (IAM). Список поддерживаемых имен функций см. в DescribeDBEngineVersions .

IAMDatabaseAuthenticationEnabled -> (булево)

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

CloneGroupId -> (строка)

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

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

Указывает время создания кластера БД в формате универсального времени координации (UTC).

CopyTagsToSnapshot -> (булево)

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

EnabledCloudwatchLogsExports -> (список)

Список типов журналов, которые этот кластер БД настроен на экспорт в CloudWatch Logs. Допустимые типы журналов: audit (для публикации аудиторских журналов в CloudWatch) и slowquery (для публикации журналов медленных запросов в CloudWatch). См. Публикация журналов Neptune в журналы Amazon CloudWatch .

(строка)

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

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

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

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

LogTypesToEnable -> (список)

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

(строка)

LogTypesToDisable -> (список)

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

(строка)

DBClusterIdentifier -> (строка)

Значение DBClusterIdentifier для кластера БД.

IAMDatabaseAuthenticationEnabled -> (булево)

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

EngineVersion -> (строка)

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

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

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

StorageType -> (строка)

Предстоящее изменение типа хранилища для кластера БД. Допустимые значения:

**standard ** – ( по умолчанию ) Настраивает экономичное хранилище базы данных для приложений с умеренной или небольшой загрузкой ввода-вывода.
**iopt1 ** – Включает хранилище с оптимизацией ввода-вывода, которое разработано для удовлетворения потребностей интенсивно используемых ввода-вывода рабочих нагрузок графов, требующих прогнозируемой стоимости с низкой задержкой ввода-вывода и постоянной пропускной способностью ввода-вывода. Хранилище Neptune с оптимизацией ввода-вывода доступно только начиная с выпуска движка 1.3.0.0.

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

Размер выделенного хранилища в гибибайтах (GiB) для движков баз данных. Для Neptune AllocatedStorage всегда возвращает 1, потому что размер хранилища кластера БД Neptune не фиксирован, а автоматически настраивается по мере необходимости.

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

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

DeletionProtection -> (булево)

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

CrossAccountClone -> (булево)

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

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

Время автоматического перезапуска кластера БД.

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

Отображает конфигурацию масштабирования кластера серверлесс БД Neptune.

Для получения дополнительной информации см. Использование Amazon Neptune Serverless в руководстве пользователя Amazon Neptune.

MinCapacity -> (double)

Минимальное количество единиц емкости Neptune (NCU) для экземпляра БД в кластере серверлесс Neptune. Вы можете указывать значения NCU с полушаговым увеличением, например 8, 8.5, 9 и т.д.

MaxCapacity -> (double)

Максимальное количество единиц емкости Neptune (NCU) для экземпляра БД в кластере серверлесс Neptune. Вы можете указывать значения NCU с полушаговым увеличением, например 40, 40.5, 41 и т.д.

GlobalClusterIdentifier -> (string)

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

IOOptimizedNextAllowedModificationTime -> (timestamp)

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

StorageType -> (string)

Тип хранения, используемый кластером БД.

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

**standard ** – (по умолчанию) Предоставляет экономичное хранилище базы данных для приложений с умеренным или небольшим использованием ввода-вывода.
**iopt1 ** – Включает оптимизированное для ввода-вывода хранилище, предназначенное для удовлетворения потребностей высоконагруженных графических рабочих нагрузок, требующих прогнозируемой стоимости с низкой задержкой ввода-вывода и стабильной пропускной способностью ввода-вывода. Хранилище Neptune, оптимизированное для ввода-вывода, доступно только начиная с версии движка 1.3.0.0.