modify-cluster-maintenance
Описание
Изменяет параметры обслуживания кластера.
См. также: Документацию API AWS
Синтаксис
modify-cluster-maintenance
--cluster-identifier <value>
[--defer-maintenance | --no-defer-maintenance]
[--defer-maintenance-identifier <value>]
[--defer-maintenance-start-time <value>]
[--defer-maintenance-end-time <value>]
[--defer-maintenance-duration <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]
Параметры
--cluster-identifier (строка)
--defer-maintenance | --no-defer-maintenance (логическое значение)
--defer-maintenance-identifier (строка)
--defer-maintenance-start-time (метка времени)
--defer-maintenance-end-time (метка времени)
--defer-maintenance-duration (целое число)
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка следует формату, указанному в --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет интерпретирована буквально. Это не может быть указано вместе с --cli-input-yaml.
--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено без значения или со значением input, выводит пример JSON-ввода, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, выведет пример ввода YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, валидирует входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.
Глобальные параметры
--debug (логическое значение)
Включить отладовую регистрацию.
--endpoint-url (строка)
Переопределить URL по умолчанию команды на указанный URL.
--no-verify-ssl (логическое значение)
По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого подключения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение по умолчанию по проверке сертификатов SSL.
--no-paginate (логическое значение)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования для вывода команды.
- json
- text
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использовать определенный профиль из файла учетных данных.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/выключить цветной вывод.
- on
- off
- auto
--no-sign-request (логическое значение)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (строка)
Файл с сертификатами CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.
--cli-read-timeout (целое число)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.
--cli-connect-timeout (целое число)
Максимальное время соединения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.
--cli-binary-format (строка)
Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как закодированная в base64 строка. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от настроек cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (логическое значение)
Отключить вывод пейджера CLI.
--cli-auto-prompt (логическое значение)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическую запрос параметров ввода CLI.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.
Изменение параметров обслуживания кластера
Следующий modify-cluster-maintenance пример откладывает обслуживание указанного кластера на 30 дней.
aws redshift modify-cluster-maintenance \
--cluster-identifier mycluster \
--defer-maintenance \
--defer-maintenance-duration 30
Вывод:
{
"Cluster": {
"ClusterIdentifier": "mycluster",
"NodeType": "dc2.large",
"ClusterStatus": "available",
"ClusterAvailabilityStatus": "Available",
"MasterUsername": "adminuser",
"DBName": "dev",
"Endpoint": {
"Address": "mycluster.cmeaswqeuae.us-west-2.redshift.amazonaws.com",
"Port": 5439
},
"ClusterCreateTime": "2019-12-05T18:44:36.991Z",
"AutomatedSnapshotRetentionPeriod": 3,
"ManualSnapshotRetentionPeriod": -1,
"ClusterSecurityGroups": [],
"VpcSecurityGroups": [
{
"VpcSecurityGroupId": "sh-a1a123ab",
"Status": "active"
}
],
"ClusterParameterGroups": [
{
"ParameterGroupName": "default.redshift-1.0",
"ParameterApplyStatus": "in-sync"
}
],
"ClusterSubnetGroupName": "default",
"VpcId": "vpc-b1ael7t9",
"AvailabilityZone": "us-west-2f",
"PreferredMaintenanceWindow": "sat:16:00-sat:16:30",
"PendingModifiedValues": {
"NodeType": "dc2.large",
"NumberOfNodes": 2,
"ClusterType": "multi-node"
},
"ClusterVersion": "1.0",
"AllowVersionUpgrade": true,
"NumberOfNodes": 4,
"PubliclyAccessible": false,
"Encrypted": false,
"ClusterSnapshotCopyStatus": {
"DestinationRegion": "us-west-1",
"RetentionPeriod": 7,
"ManualSnapshotRetentionPeriod": -1
},
"Tags": [
{
"Key": "mytags",
"Value": "tag1"
}
],
"EnhancedVpcRouting": false,
"IamRoles": [],
"MaintenanceTrackName": "current",
"DeferredMaintenanceWindows": [
{
"DeferMaintenanceIdentifier": "dfm-mUdVIfFcT1B4SGhw6fyF",
"DeferMaintenanceStartTime": "2019-12-10T18:18:39.354Z",
"DeferMaintenanceEndTime": "2020-01-09T18:18:39.354Z"
}
],
"ExpectedNextSnapshotScheduleTime": "2019-12-11T04:42:55.631Z",
"ExpectedNextSnapshotScheduleTimeStatus": "OnTrack",
"NextMaintenanceWindowStartTime": "2020-01-11T16:00:00Z"
}
}
Дополнительную информацию см. в разделе Обслуживание кластеров в Руководстве по управлению Amazon Redshift Cluster.
Вывод
Кластер -> (структура)
Описывает кластер.
ClusterIdentifier -> (строка)
NodeType -> (строка)
ClusterStatus -> (строка)
Текущее состояние кластера. Возможные значения:
availableavailable, prep-for-resizeavailable, resize-cleanupcancelling-resizecreatingdeletingfinal-snapshothardware-failureincompatible-hsmincompatible-networkincompatible-parametersincompatible-restoremodifyingpausedrebootingrenamingresizingrotating-keysstorage-fullupdating-hsm
ClusterAvailabilityStatus -> (строка)
Статус доступности кластера для запросов. Возможные значения:
- Доступно - Кластер доступен для запросов.
- Недоступно - Кластер недоступен для запросов.
- Техническое обслуживание - Кластер временно доступен для запросов из-за работ по техническому обслуживанию.
- Модифицируется - Кластер временно доступен для запросов из-за изменений, которые изменяют кластер.
- Неудачно - Кластер неисправен и недоступен для запросов.
ModifyStatus -> (строка)
MasterUsername -> (строка)
DBName -> (строка)
dev dev.Endpoint -> (структура)
Точка подключения.
Address -> (строка)
Port -> (целое число)
VpcEndpoints -> (список)
Описывает точку подключения.
(структура)
Точка подключения для подключения к кластеру Amazon Redshift через прокси-сервер.
VpcEndpointId -> (строка)
VpcId -> (строка)
NetworkInterfaces -> (список)
Один или несколько сетевых интерфейсов точки подключения. Также известны как интерфейсные точки подключения.
(структура)
Описывает сетевой интерфейс.
NetworkInterfaceId -> (строка)
SubnetId -> (строка)
PrivateIpAddress -> (строка)
AvailabilityZone -> (строка)
Ipv6Address -> (строка)
ClusterCreateTime -> (метка времени)
AutomatedSnapshotRetentionPeriod -> (целое число)
ManualSnapshotRetentionPeriod -> (целое число)
Стандартное количество дней для хранения ручных снимков. Если значение равно -1, снимок хранится неопределенно. Это настройка не меняет срок хранения существующих снимков.
Значение должно быть либо -1, либо целым числом от 1 до 3653.
ClusterSecurityGroups -> (список)
Список групп безопасности кластера, связанных с кластером. Каждая группа безопасности представлена элементом, содержащим подэлементы ClusterSecurityGroup.Name и ClusterSecurityGroup.Status.
Группы безопасности кластера используются, когда кластер не создается в виртуальной частной сети Amazon (VPC). Кластеры, созданные в VPC, используют группы безопасности VPC, которые перечисляются параметром VpcSecurityGroups.
(структура)
Описание группы безопасности кластера.
ClusterSecurityGroupName -> (строка)
Status -> (строка)
VpcSecurityGroups -> (список)
Список групп безопасности виртуальной частной сети Amazon (Amazon VPC), связанных с кластером. Этот параметр возвращается только если кластер находится в VPC.
(структура)
Описание членов группы безопасности VPC.
VpcSecurityGroupId -> (строка)
Status -> (строка)
ClusterParameterGroups -> (список)
Список групп параметров кластера, связанных с этим кластером. Каждая группа параметров в списке возвращается со своим статусом.
(структура)
Описание статуса группы параметров.
ParameterGroupName -> (строка)
ParameterApplyStatus -> (строка)
ClusterParameterStatusList -> (список)
Список статусов параметров.
Дополнительную информацию о параметрах и группах параметров см. в разделе Amazon Redshift Parameter Groups в руководстве по управлению кластерами Amazon Redshift.
(структура)
Описание статуса группы параметров.
ParameterName -> (строка)
ParameterApplyStatus -> (строка)
Статус параметра, указывающий, синхронизирован ли параметр с базой данных, ожидает ли перезагрузки кластера или при его применении возникла ошибка.
Возможные статусы и описания:
-
in-sync: Значение параметра синхронизировано с базой данных. -
pending-reboot: Значение параметра будет применено после перезагрузки кластера. -
applying: Значение параметра применяется к базе данных. -
invalid-parameter: Значение параметра не может быть применено, так как оно имеет недопустимое значение или синтаксис. -
apply-deferred: Параметр содержит статические изменения свойств. Изменения отложены до перезагрузки кластера. -
apply-error: Невозможно подключиться к кластеру. Изменение параметра будет применено после перезагрузки кластера. -
unknown-error: В данный момент невозможно применить изменение параметра. Изменение будет применено после перезагрузки кластера.
ParameterApplyErrorDescription -> (строка)
ClusterSubnetGroupName -> (строка)
VpcId -> (строка)
AvailabilityZone -> (строка)
PreferredMaintenanceWindow -> (строка)
PendingModifiedValues -> (структура)
Значение, которое, если присутствует, указывает на то, что изменения в кластере находятся в ожидании. Конкретные ожидаемые изменения определяются подэлементами.
MasterUserPassword -> (строка)
NodeType -> (строка)
NumberOfNodes -> (целое число)
ClusterType -> (строка)
ClusterVersion -> (строка)
AutomatedSnapshotRetentionPeriod -> (целое число)
ClusterIdentifier -> (строка)
PubliclyAccessible -> (булево)
EnhancedVpcRouting -> (булево)
Параметр, указывающий, нужно ли создавать кластер с включенным улучшенным маршрутизацией VPC. Чтобы создать кластер, использующий улучшенную маршрутизацию VPC, кластер должен находиться в VPC. Дополнительную информацию см. в разделе Улучшенная маршрутизация VPC в руководстве по управлению кластерами Amazon Redshift.
Если этот параметр равен true, улучшенная маршрутизация VPC включена.
По умолчанию: false
MaintenanceTrackName -> (строка)
EncryptionType -> (строка)
ClusterVersion -> (строка)
AllowVersionUpgrade -> (булево)
true, указывает, что автоматические обновления до основной версии будут применяться к кластеру во время окна технического обслуживания.NumberOfNodes -> (целое число)
PubliclyAccessible -> (булево)
Булево значение, которое, если true, указывает, что к кластеру можно получить доступ из общедоступной сети.
По умолчанию: false
Encrypted -> (булево)
true, указывает, что данные в кластере шифруются в состоянии покоя.RestoreStatus -> (структура)
Значение, описывающее состояние действия восстановления кластера. Этот параметр возвращает null, если кластер не был создан путём восстановления из снимка.
Status -> (строка)
CurrentRestoreRateInMegaBytesPerSecond -> (двойное)
SnapshotSizeInMegaBytes -> (целое)
ProgressInMegaBytes -> (целое)
ElapsedTimeInSeconds -> (целое)
EstimatedTimeToCompletionInSeconds -> (целое)
DataTransferProgress -> (структура)
Status -> (строка)
transferringdata.CurrentRateInMegaBytesPerSecond -> (двойное)
TotalDataInMegaBytes -> (целое)
DataTransferredInMegaBytes -> (целое)
EstimatedTimeToCompletionInSeconds -> (целое)
ElapsedTimeInSeconds -> (целое)
HsmStatus -> (структура)
Значение, которое сообщает, завершил ли Amazon Redshift кластер применение любых изменений настроек модуля аппаратной безопасности (HSM), указанных в команде модификации кластера.
Значения: active, applying
HsmClientCertificateIdentifier -> (строка)
HsmConfigurationIdentifier -> (строка)
Status -> (строка)
Сообщает, завершил ли Amazon Redshift кластер применение любых изменений настроек HSM, указанных в команде модификации кластера.
Значения: active, applying
ClusterSnapshotCopyStatus -> (структура)
Значение, которое возвращает целевой регион и период хранения, настроенные для межрегионального копирования снимков.
DestinationRegion -> (строка)
RetentionPeriod -> (целое)
ManualSnapshotRetentionPeriod -> (целое)
Количество дней, в течение которых автоматические снимки сохраняются в целевом регионе после копирования из исходного региона. Если значение равно -1, ручной снимок сохраняется неопределённо долго.
Значение должно быть либо -1, либо целое число от 1 до 3653.
SnapshotCopyGrantName -> (строка)
ClusterPublicKey -> (строка)
ClusterNodes -> (список)
Узлы в кластере.
(структура)
Идентификатор узла в кластере.
NodeRole -> (строка)
PrivateIPAddress -> (строка)
PublicIPAddress -> (строка)
ElasticIpStatus -> (структура)
Состояние адреса эластичного IP (EIP).
ElasticIp -> (строка)
Status -> (строка)
ClusterRevisionNumber -> (строка)
Tags -> (список)
Список тегов для кластера.
(структура)
Тег, состоящий из пары имя/значение для ресурса.
Key -> (строка)
Value -> (строка)
KmsKeyId -> (строка)
EnhancedVpcRouting -> (логическое)
Параметр, определяющий, должен ли быть создан кластер с включённым улучшенным маршрутизацией VPC. Для создания кластера, использующего улучшенную маршрутизацию VPC, кластер должен находиться в VPC. Дополнительную информацию см. в руководстве по управлению кластерами Amazon Redshift.
Если этот параметр равен true, улучшенная маршрутизация VPC включена.
По умолчанию: false
IamRoles -> (список)
Список ролей управления доступом и идентификацией (IAM), которые могут использоваться кластером для доступа к другим службам Amazon Web Services.
(структура)
Роль управления доступом и идентификацией (IAM), которую может использовать связанный Amazon Redshift кластер для доступа к другим службам Amazon Web Services.
IamRoleArn -> (строка)
arn:aws:iam::123456789012:role/RedshiftCopyUnload.ApplyStatus -> (строка)
Значение, описывающее состояние ассоциации роли IAM с Amazon Redshift кластером.
Возможные состояния и их описания:
-
in-sync: Роль доступна для использования кластером. -
adding: Роль находится в процессе ассоциации с кластером. -
removing: Роль находится в процессе отсоединения от кластера.
PendingActions -> (список)
Операции кластера, ожидающие начала.
(строка)
MaintenanceTrackName -> (строка)
ElasticResizeNumberOfNodeOptions -> (строка)
DeferredMaintenanceWindows -> (список)
Описывает группу объектов DeferredMaintenanceWindow.
(структура)
Описывает окно обслуживания с отсрочкой.
DeferMaintenanceIdentifier -> (строка)
DeferMaintenanceStartTime -> (метка времени)
DeferMaintenanceEndTime -> (метка времени)
SnapshotScheduleIdentifier -> (строка)
SnapshotScheduleState -> (строка)
ExpectedNextSnapshotScheduleTime -> (метка времени)
ExpectedNextSnapshotScheduleTimeStatus -> (строка)
Состояние следующего ожидаемого снимка для кластеров с действительным расписанием снимков и включёнными резервными копиями. Возможные значения следующие:
- OnTrack - Следующий снимок ожидается в установленное время.
- Pending - Следующий снимок ожидает создания.
NextMaintenanceWindowStartTime -> (метка времени)
ResizeInfo -> (структура)
Возвращает следующее:
- AllowCancelResize: логическое значение, указывающее, можно ли отменить операцию изменения размера.
- ResizeType: Возвращает ClassicResize
ResizeType -> (строка)
ClassicResize.AllowCancelResize -> (логическое)
AvailabilityZoneRelocationStatus -> (строка)
ClusterNamespaceArn -> (строка)
TotalStorageCapacityInMegaBytes -> (целое)
AquaConfiguration -> (структура)
Это поле снято с производства. Amazon Redshift автоматически определяет, следует ли использовать AQUA (Advanced Query Accelerator).
AquaStatus -> (строка)
AquaConfigurationStatus -> (строка)
DefaultIamRoleArn -> (строка)
ReservedNodeExchangeStatus -> (структура)
Состояние запроса обмена резервированными узлами. Статусы включают в себя в процессе и запрошен.
ReservedNodeExchangeRequestId -> (строка)
Status -> (строка)
RequestTime -> (метка времени)
SourceReservedNodeId -> (строка)
SourceReservedNodeType -> (строка)
SourceReservedNodeCount -> (целое)
TargetReservedNodeOfferingId -> (строка)
TargetReservedNodeType -> (строка)
TargetReservedNodeCount -> (целое)
CustomDomainName -> (строка)
CustomDomainCertificateArn -> (строка)
CustomDomainCertificateExpiryDate -> (метка времени)
MasterPasswordSecretArn -> (string)
MasterPasswordSecretKmsKeyId -> (string)
IpAddressType -> (string)
ipv4 и dualstack.MultiAZ -> (string)
MultiAZSecondary -> (structure)
Вторичный вычислительный узел кластера, если включено многозонное развертывание.
AvailabilityZone -> (string)
ClusterNodes -> (list)
Узлы во вторичном вычислительном узле.
(structure)
Идентификатор узла в кластере.
NodeRole -> (string)
PrivateIPAddress -> (string)
PublicIPAddress -> (string)
© Copyright 2025, Amazon Web Services. Created using Sphinx.