modify-db-cluster

Описание

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

См. также: Документацию 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>]
[--preferred-backup-window <value>]
[--preferred-maintenance-window <value>]
[--cloudwatch-logs-export-configuration <value>]
[--engine-version <value>]
[--allow-major-version-upgrade | --no-allow-major-version-upgrade]
[--deletion-protection | --no-deletion-protection]
[--storage-type <value>]
[--manage-master-user-password | --no-manage-master-user-password]
[--master-user-secret-kms-key-id <value>]
[--rotate-master-user-password | --no-rotate-master-user-password]
[--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 и MasterUserPassword. Если вы установите значение этого параметра в false , изменения значений NewDBClusterIdentifier и MasterUserPassword применяются в течение следующего окна обслуживания. Все другие изменения применяются немедленно, независимо от значения параметра 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 (строка)

Пароль пользователя главной базы данных. Этот пароль может содержать любые печатные символы ASCII, кроме косой черты (/), двойной кавычки (“) или символа «@».

Ограничения: должен содержать от 8 до 100 символов.

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

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

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

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

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

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

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

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

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

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

Ограничения: Минимальный интервал 30 минут.

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

Настройка параметров для типов журналов, которые необходимо включить для экспорта в Amazon CloudWatch Logs для конкретного экземпляра или кластера. Массивы EnableLogTypes и DisableLogTypes определяют, какие журналы экспортируются (или не экспортируются) в CloudWatch Logs.

EnableLogTypes -> (список)

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

(строка)

DisableLogTypes -> (список)

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

(строка)

Сокращенная запись:

EnableLogTypes=string,string,DisableLogTypes=string,string

Синтаксис JSON:

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

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

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

Для перечисления всех доступных версий движка Amazon DocumentDB используйте следующую команду:

aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"

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

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

Ограничения: необходимо разрешить обновления основных версий при указании значения для параметра EngineVersion, которое отличается от текущей версии DB-кластера.

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

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

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

Тип хранилища, который нужно связать с DB-кластером.

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

Допустимые значения типа хранилища - standard | iopt1

Значение по умолчанию — standard

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

Указывает, следует ли управлять паролем пользователя-владельца с помощью Amazon Web Services Secrets Manager. Если кластер не управляет паролем пользователя-владельца с помощью Amazon Web Services Secrets Manager, вы можете включить это управление. В этом случае вы не можете указать MasterUserPassword. Если кластер уже управляет паролем пользователя-владельца с помощью Amazon Web Services Secrets Manager и вы укажете, что пароль пользователя-владельца не управляется с помощью Amazon Web Services Secrets Manager, тогда вы должны указать MasterUserPassword. В этом случае Amazon DocumentDB удаляет секрет и использует новый пароль для пользователя-владельца, указанный в MasterUserPassword.

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

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

Это значение действует только при соблюдении следующих условий:

Кластер не управляет паролем пользователя-владельца в Amazon Web Services Secrets Manager. Если кластер уже управляет паролем пользователя-владельца в Amazon Web Services Secrets Manager, вы не можете изменить ключ KMS, используемый для шифрования секрета.
Вы включаете ManageMasterUserPassword для управления паролем пользователя-владельца в Amazon Web Services Secrets Manager. Если вы включаете ManageMasterUserPassword и не указываете MasterUserSecretKmsKeyId, для шифрования секрета используется ключ KMS aws/secretsmanager. Если секрет находится в другой учетной записи Amazon Web Services, то вы не можете использовать ключ KMS aws/secretsmanager для шифрования секрета и должны использовать управляемый пользователем ключ KMS.

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

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

--rotate-master-user-password | --no-rotate-master-user-password (логическое значение)

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

Это значение действует только в том случае, если пароль пользователя-владельца управляется Amazon DocumentDB в Amazon Web Services Secrets Manager для кластера. Значение секрета содержит обновленный пароль.

Ограничение: изменения необходимо применять немедленно при вращении пароля пользователя-владельца.

--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-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

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

--cli-connect-timeout (целое число)

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

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как закодированная строка base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от параметра cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного параметра cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (логическое значение)

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

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Примеры

Примечание

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

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

Для изменения кластера Amazon DocumentDB

Следующий modify-db-cluster пример изменяет кластер Amazon DocumentDB sample-cluster, устанавливая период удержания автоматических резервных копий в 7 дней и изменяя предпочитаемые окна для резервных копий и обслуживания. Все изменения применяются в следующем окне обслуживания.

aws docdb modify-db-cluster \
    --db-cluster-identifier sample-cluster \
    --no-apply-immediately \
    --backup-retention-period 7 \
    --preferred-backup-window 18:00-18:30 \
    --preferred-maintenance-window sun:20:00-sun:20:30

Вывод:

{
    "DBCluster": {
        "Endpoint": "sample-cluster.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
        "DBClusterMembers": [
            {
                "DBClusterParameterGroupStatus": "in-sync",
                "DBInstanceIdentifier": "sample-cluster",
                "IsClusterWriter": true,
                "PromotionTier": 1
            },
            {
                "DBClusterParameterGroupStatus": "in-sync",
                "DBInstanceIdentifier": "sample-cluster2",
                "IsClusterWriter": false,
                "PromotionTier": 2
            }
        ],
        "HostedZoneId": "ZNKXH85TT8WVW",
        "StorageEncrypted": false,
        "PreferredBackupWindow": "18:00-18:30",
        "MultiAZ": true,
        "EngineVersion": "3.6.0",
        "MasterUsername": "master-user",
        "ReaderEndpoint": "sample-cluster.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com",
        "DBSubnetGroup": "default",
        "LatestRestorableTime": "2019-03-18T22:08:13.408Z",
        "EarliestRestorableTime": "2019-03-15T20:30:47.020Z",
        "PreferredMaintenanceWindow": "sun:20:00-sun:20:30",
        "AssociatedRoles": [],
        "EnabledCloudwatchLogsExports": [
            "audit"
        ],
        "Engine": "docdb",
        "DBClusterParameterGroup": "default.docdb3.6",
        "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster",
        "BackupRetentionPeriod": 7,
        "DBClusterIdentifier": "sample-cluster",
        "AvailabilityZones": [
            "us-west-2a",
            "us-west-2c",
            "us-west-2b"
        ],
        "Status": "available",
        "DbClusterResourceId": "cluster-UP4EF2PVDDFVHHDJQTYDAIGHLE",
        "ClusterCreateTime": "2019-03-15T20:29:58.836Z",
        "VpcSecurityGroups": [
            {
                "VpcSecurityGroupId": "sg-77186e0d",
                "Status": "active"
            }
        ],
        "Port": 27017
    }
}

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

Вывод

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

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

AvailabilityZones -> (список)

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

(строка)

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

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

DBClusterIdentifier -> (строка)

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

DBClusterParameterGroup -> (строка)

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

DBSubnetGroup -> (строка)

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

Status -> (строка)

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

PercentProgress -> (строка)

Указывает ход операции в процентах.

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

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

Endpoint -> (строка)

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

ReaderEndpoint -> (строка)

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

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

MultiAZ -> (булево)

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

Engine -> (строка)

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

EngineVersion -> (строка)

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

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

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

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

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

MasterUsername -> (строка)

Содержит имя пользователя мастера для кластера.

PreferredBackupWindow -> (строка)

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

PreferredMaintenanceWindow -> (строка)

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

ReplicationSourceIdentifier -> (строка)

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

ReadReplicaIdentifiers -> (список)

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

(строка)

DBClusterMembers -> (список)

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

(структура)

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

DBInstanceIdentifier -> (строка)

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

IsClusterWriter -> (булево)

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

DBClusterParameterGroupStatus -> (строка)

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

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

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

VpcSecurityGroups -> (список)

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

(структура)

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

VpcSecurityGroupId -> (строка)

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

Status -> (строка)

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

HostedZoneId -> (строка)

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

StorageEncrypted -> (булево)

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

KmsKeyId -> (строка)

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

DbClusterResourceId -> (строка)

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

DBClusterArn -> (строка)

Amazon Resource Name (ARN) кластера.

AssociatedRoles -> (список)

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

(структура)

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

RoleArn -> (строка)

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

Status -> (строка)

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

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

CloneGroupId -> (строка)

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

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

Указывает время создания кластера в формате UTC (Всемирное координированное время).

EnabledCloudwatchLogsExports -> (список)

Список типов журналов, которые этот кластер настроен экспортировать в Amazon CloudWatch Logs.

(строка)

DeletionProtection -> (булево)

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

StorageType -> (строка)

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

Дополнительную информацию о типах хранилища для кластеров Amazon DocumentDB см. в разделе «Конфигурации хранилища кластеров» в Руководстве разработчика Amazon DocumentDB.

Допустимые значения для типа хранилища - standard | iopt1

Значение по умолчанию - standard

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

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

SecretArn -> (строка)

Amazon Resource Name (ARN) секрета.

SecretStatus -> (строка)

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

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

creating - Секрет создаётся.
active - Секрет доступен для обычного использования и вращения.
rotating - Секрет вращается.
impaired - Секрет может использоваться для доступа к данным аутентификации базы данных, но не может вращаться. Секрет может иметь такой статус, например, если права изменены таким образом, что Amazon DocumentDB больше не может получить доступ ни к секрету, ни к ключу KMS для секрета. Когда секрет имеет этот статус, вы можете исправить ситуацию, которая привела к этому статусу. Или измените экземпляр, чтобы отключить автоматическое управление учетными данными базы данных, а затем снова измените экземпляр, чтобы включить автоматическое управление учетными данными базы данных.

KmsKeyId -> (строка)

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