Spec-Zone.ru › AWS CLI v2

[ aws . redshift ]

create-cluster

Описание

Создает новый кластер с указанными параметрами.

Для создания кластера в виртуальной частной сети (VPC) необходимо указать имя группы подсетей кластера. Группа подсетей кластера определяет подсети вашей VPC, которые Amazon Redshift использует при создании кластера. Дополнительную информацию о управлении кластерами см. в руководстве Amazon Redshift Cluster Management Guide в разделе Amazon Redshift Clusters.

Блокирование публичного доступа к VPC (BPA) позволяет блокировать ресурсы в VPC и подсетях, которые вам принадлежат в регионе, от доступа к интернету или доступа из интернета через интернет-шлюзы и интернет-шлюзы только для исходящего трафика. Если группа подсетей для подготовленного кластера находится в аккаунте с включенным VPC BPA, следующие возможности заблокированы:

  • Создание публичного кластера
  • Восстановление публичного кластера
  • Изменение частного кластера на публичный
  • Добавление подсети с включенным VPC BPA в группу подсетей, когда в группе есть хотя бы один публичный кластер

Дополнительную информацию о VPC BPA см. в руководстве Amazon VPC User Guide в разделе Блокирование публичного доступа к VPC и подсетям.

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

Синтаксис

  create-cluster
[--db-name <value>]
--cluster-identifier <value>
[--cluster-type <value>]
--node-type <value>
--master-username <value>
[--master-user-password <value>]
[--cluster-security-groups <value>]
[--vpc-security-group-ids <value>]
[--cluster-subnet-group-name <value>]
[--availability-zone <value>]
[--preferred-maintenance-window <value>]
[--cluster-parameter-group-name <value>]
[--automated-snapshot-retention-period <value>]
[--manual-snapshot-retention-period <value>]
[--port <value>]
[--cluster-version <value>]
[--allow-version-upgrade | --no-allow-version-upgrade]
[--number-of-nodes <value>]
[--publicly-accessible | --no-publicly-accessible]
[--encrypted | --no-encrypted]
[--hsm-client-certificate-identifier <value>]
[--hsm-configuration-identifier <value>]
[--elastic-ip <value>]
[--tags <value>]
[--kms-key-id <value>]
[--enhanced-vpc-routing | --no-enhanced-vpc-routing]
[--additional-info <value>]
[--iam-roles <value>]
[--maintenance-track-name <value>]
[--snapshot-schedule-identifier <value>]
[--availability-zone-relocation | --no-availability-zone-relocation]
[--aqua-configuration-status <value>]
[--default-iam-role-arn <value>]
[--load-sample-data <value>]
[--manage-master-password | --no-manage-master-password]
[--master-password-secret-kms-key-id <value>]
[--ip-address-type <value>]
[--multi-az | --no-multi-az]
[--redshift-idc-application-arn <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 (строка)

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

Чтобы создать дополнительные базы данных после создания кластера, подключитесь к кластеру с помощью SQL-клиента и используйте SQL-команды для создания базы данных. Дополнительную информацию см. в руководстве разработчика базы данных Amazon Redshift по созданию базы данных.

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

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

  • Должно содержать от 1 до 64 буквенно-цифровых символов.
  • Должно содержать только строчные буквы.
  • Не должно быть зарезервированным словом службы. Список зарезервированных слов см. в руководстве разработчика базы данных Amazon Redshift по зарезервированным словам.

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

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

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

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

Пример: myexamplecluster

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

Тип кластера. Когда тип кластера указан как

  • single-node, параметр NumberOfNodes не требуется.
  • multi-node, параметр NumberOfNodes требуется.

Допустимые значения: multi-node | single-node

По умолчанию: multi-node

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

Тип узла, который необходимо зарезервировать для кластера. Дополнительную информацию о типах узлов см. в разделе Работа с кластерами в руководстве по управлению кластерами Amazon Redshift.

Допустимые значения: dc2.large | dc2.8xlarge | ra3.large | ra3.xlplus | ra3.4xlarge | ra3.16xlarge

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

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

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

  • Должно содержать от 1 до 128 буквенно-цифровых символов или дефисов. Имя пользователя не может быть PUBLIC.
  • Должно содержать только строчные буквы, цифры, символ подчеркивания, плюс, точку, символ @ или дефис.
  • Первый символ должен быть буквой.
  • Не должно содержать двоеточия (:) или косую черту (/).
  • Не должно быть зарезервированным словом. Список зарезервированных слов см. в руководстве разработчика базы данных Amazon Redshift по зарезервированным словам.

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

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

Вы не можете использовать MasterUserPassword, если ManageMasterPassword равно true.

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

  • Длина должна быть от 8 до 64 символов.
  • Должно содержать хотя бы одну заглавную букву.
  • Должно содержать хотя бы одну строчную букву.
  • Должно содержать хотя бы одну цифру.
  • Может содержать любые печатные ASCII-символы (код ASCII 33-126) кроме ' (одинарная кавычка), " (двойная кавычка), \ , / или @ .

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

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

По умолчанию: группа безопасности по умолчанию для Amazon Redshift.

(строка)

Синтаксис:

"string" "string" ...

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

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

По умолчанию: с кластером связана группа безопасности VPC по умолчанию.

(строка)

Синтаксис:

"string" "string" ...

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

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

Если этот параметр не указан, результирующий кластер будет развернут вне виртуальной частной сети (VPC).

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

Зона доступности EC2 (AZ), в которой вы хотите, чтобы Amazon Redshift развернул кластер. Например, если у вас несколько EC2-инстансов, работающих в определенной зоне доступности, вы можете развернуть кластер в той же зоне, чтобы снизить сетевую задержку.

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

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

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

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

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

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

По умолчанию: 30-минутный интервал, выбранный случайным образом из 8-часового временного блока в каждом регионе, в случайный день недели. Дополнительную информацию о временных блоках для каждого региона см. в руководстве по управлению кластерами Amazon Redshift в разделе "Окна технического обслуживания".

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

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

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

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

По умолчанию: группа параметров кластера Amazon Redshift по умолчанию. Дополнительную информацию о группе параметров по умолчанию см. в разделе Работа с группами параметров Amazon Redshift.

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

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

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

Количество дней, в течение которых сохраняются автоматические снимки. Если значение равно 0, автоматические снимки отключены. Даже если автоматические снимки отключены, вы по-прежнему можете создавать ручные снимки при необходимости с помощью CreateClusterSnapshot.

Автоматические снимки нельзя отключить для типов узлов RA3. Установите период автоматического хранения от 1 до 35 дней.

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

Ограничения: значение должно быть от 0 до 35.

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

Количество дней, в течение которых сохраняется ручной снимок по умолчанию. Если значение равно -1, снимок хранится неопределенно долго. Это значение не изменяет период хранения существующих снимков.

Значение должно быть либо -1, либо целым числом от 1 до 3653.

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

Номер порта, на котором кластер принимает входящие соединения.

Доступ к кластеру возможен только через строки подключения JDBC и ODBC. Часть строки подключения требует порта, на котором кластер будет принимать входящие соединения.

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

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

  • Для кластеров с узлами ra3 - выберите порт в диапазонах 5431-5455 или 8191-8215. (Если у вас есть существующий кластер с узлами ra3, вам не нужно менять порт на эти диапазоны.)
  • Для кластеров с узлами dc2 - выберите порт в диапазоне 1150-65535.

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

Версия программного обеспечения Amazon Redshift, которую вы хотите развернуть на кластере.

Выбранная версия работает на всех узлах кластера.

Ограничения: в настоящее время доступна только версия 1.0.

Пример: 1.0

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

Если true, обновления основных версий могут применяться во время окна технического обслуживания к Amazon Redshift-движку, работающему на кластере.

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

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

--number-of-nodes (целое число)

Количество вычислительных узлов в кластере. Этот параметр требуется, когда параметр ClusterType указан как multi-node.

Дополнительную информацию о том, сколько узлов вам нужно, см. в разделе Работа с кластерами в руководстве по управлению кластерами Amazon Redshift.

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

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

Ограничения: значение должно быть не менее 1 и не более 100.

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

Если true, к кластеру можно получить доступ из общедоступной сети.

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

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

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

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

--hsm-client-certificate-identifier (строка)

Указывает имя сертификата клиента HSM, используемого кластером Amazon Redshift для получения ключей шифрования данных, хранящихся в HSM.

--hsm-configuration-identifier (строка)

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

--elastic-ip (строка)

Адрес Elastic IP (EIP) для кластера.

Ограничения: кластер должен быть развернут в EC2-VPC и доступен через шлюз в Интернет. Не указывайте адрес Elastic IP для общедоступного кластера, в котором включено перераспределение зоны доступности. Дополнительную информацию о развертывании кластеров в EC2-VPC см. в руководстве по управлению кластерами Amazon Redshift в разделе Поддерживаемые платформы для запуска вашего кластера.

--tags (список)

Список экземпляров тегов.

(структура)

Тег, состоящий из пары имя/значение для ресурса.

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

Ключ или имя тега ресурса.

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

Значение тега ресурса.

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

Key=string,Value=string ...

Синтаксис JSON:

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

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

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

--enhanced-vpc-routing | --no-enhanced-vpc-routing (булево)

Параметр, указывающий, нужно ли создавать кластер с включенным расширенным маршрутизацией VPC. Для создания кластера, использующего расширенную маршрутизацию VPC, кластер должен находиться в VPC. Дополнительную информацию см. в руководстве по управлению кластерами Amazon Redshift в разделе Расширенная маршрутизация VPC.

Если этот параметр равен true, расширенная маршрутизация VPC включена.

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

--additional-info (строка)

Зарезервировано.

--iam-roles (список)

Список ролей управления идентификацией и доступом (IAM), которые могут использоваться кластером для доступа к другим службам Amazon Web Services. Вам необходимо указать роли IAM в формате Amazon Resource Name (ARN).

Максимальное количество ролей IAM, которые вы можете ассоциировать, ограничено квотой. Дополнительную информацию можно найти в разделе «Квоты и ограничения» в руководстве по управлению кластерами Amazon Redshift.

(строка)

Синтаксис:

"string" "string" ...

--maintenance-track-name (строка)

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

--snapshot-schedule-identifier (строка)

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

--availability-zone-relocation | --no-availability-zone-relocation (логическое значение)

Параметр для включения возможности перемещения кластера Amazon Redshift между зонами доступности после создания кластера.

--aqua-configuration-status (строка)

Этот параметр устарел. Он не устанавливает состояние конфигурации AQUA. Amazon Redshift автоматически определяет, использовать ли AQUA (Advanced Query Accelerator).

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

  • enabled
  • disabled
  • auto

--default-iam-role-arn (строка)

Amazon Resource Name (ARN) для роли IAM, которая была установлена по умолчанию для кластера при его создании.

--load-sample-data (строка)

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

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

Если true, Amazon Redshift использует Secrets Manager для управления учетными данными администратора этого кластера. Вы не можете использовать MasterUserPassword, если ManageMasterPassword имеет значение true. Если ManageMasterPassword имеет значение false или не задано, Amazon Redshift использует MasterUserPassword для пароля учетной записи администратора.

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

Идентификатор ключа управления ключами (KMS), используемого для шифрования и хранения секрета учетных данных администратора кластера. Вы можете использовать этот параметр только в том случае, если ManageMasterPassword имеет значение true.

--ip-address-type (строка)

Типы IP-адресов, поддерживаемые кластером. Возможные значения — ipv4 и dualstack.

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

Если true, Amazon Redshift развернет кластер в двух зонах доступности (AZ).

--redshift-idc-application-arn (строка)

Amazon Resource Name (ARN) приложения Amazon Redshift IAM Identity Center.

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

--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.

Создание кластера с минимальным набором параметров

В этом примере создается кластер с минимальным набором параметров. По умолчанию вывод осуществляется в формате JSON.

Команда:

aws redshift create-cluster --node-type dw.hs1.xlarge --number-of-nodes 2 --master-username adminuser --master-user-password TopSecret1 --cluster-identifier mycluster

Результат:

{
   "Cluster": {
      "NodeType": "dw.hs1.xlarge",
      "ClusterVersion": "1.0",
      "PubliclyAccessible": "true",
      "MasterUsername": "adminuser",
      "ClusterParameterGroups": [
         {
            "ParameterApplyStatus": "in-sync",
            "ParameterGroupName": "default.redshift-1.0"
         } ],
      "ClusterSecurityGroups": [
         {
            "Status": "active",
            "ClusterSecurityGroupName": "default"
         } ],
      "AllowVersionUpgrade": true,
      "VpcSecurityGroups": \[],
      "PreferredMaintenanceWindow": "sat:03:30-sat:04:00",
      "AutomatedSnapshotRetentionPeriod": 1,
      "ClusterStatus": "creating",
      "ClusterIdentifier": "mycluster",
      "DBName": "dev",
      "NumberOfNodes": 2,
      "PendingModifiedValues": {
         "MasterUserPassword": "\****"
      }
   },
   "ResponseMetadata": {
      "RequestId": "7cf4bcfc-64dd-11e2-bea9-49e0ce183f07"
   }
}

Вывод

Кластер -> (структура)

Описывает кластер.

ClusterIdentifier -> (строка)

Уникальный идентификатор кластера.

NodeType -> (строка)

Тип узла для узлов в кластере.

ClusterStatus -> (строка)

Текущее состояние кластера. Возможные значения:

  • available
  • available, prep-for-resize
  • available, resize-cleanup
  • cancelling-resize
  • creating
  • deleting
  • final-snapshot
  • hardware-failure
  • incompatible-hsm
  • incompatible-network
  • incompatible-parameters
  • incompatible-restore
  • modifying
  • paused
  • rebooting
  • renaming
  • resizing
  • rotating-keys
  • storage-full
  • updating-hsm

ClusterAvailabilityStatus -> (строка)

Статус доступности кластера для запросов. Возможные значения:

  • Доступно - Кластер доступен для запросов.
  • Недоступно - Кластер недоступен для запросов.
  • Техническое обслуживание - Кластер периодически доступен для запросов из-за работ по техническому обслуживанию.
  • Изменение - Кластер периодически доступен для запросов из-за изменений, которые модифицируют кластер.
  • Неудачно - Кластер потерпел неудачу и недоступен для запросов.

ModifyStatus -> (строка)

Статус операции модификации, если таковая была инициирована для кластера.

MasterUsername -> (строка)

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

DBName -> (строка)

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

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

Конечная точка подключения.

Address -> (строка)

DNS-адрес кластера.

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

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

VpcEndpoints -> (список)

Описание конечной точки подключения.

(структура)

Конечная точка подключения для подключения к кластеру Amazon Redshift через прокси.

VpcEndpointId -> (строка)

Идентификатор конечной точки подключения для подключения к кластеру Amazon Redshift через прокси.

VpcId -> (строка)

Идентификатор VPC, к которому привязана конечная точка.

NetworkInterfaces -> (список)

Один или несколько сетевых интерфейсов конечной точки. Также известен как интерфейсная конечная точка.

(структура)

Описание сетевого интерфейса.

NetworkInterfaceId -> (строка)

Идентификатор сетевого интерфейса.

SubnetId -> (строка)

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

PrivateIpAddress -> (строка)

IPv4-адрес сетевого интерфейса в подсети.

AvailabilityZone -> (строка)

Зона доступности.

Ipv6Address -> (строка)

IPv6-адрес сетевого интерфейса в подсети.

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

Дата и время создания кластера.

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

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

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

Количество дней, в течение которых сохраняется ручная копия снимка по умолчанию. Если значение равно -1, снимок сохраняется неограниченно. Это значение не изменяет срок хранения существующих снимков.

Значение должно быть либо -1, либо целым числом от 1 до 3653.

ClusterSecurityGroups -> (список)

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

Группы безопасности кластера используются, когда кластер не создается в Amazon Virtual Private Cloud (VPC). Кластеры, созданные в VPC, используют группы безопасности VPC, которые перечисляются параметром VpcSecurityGroups.

(структура)

Описание группы безопасности кластера.

ClusterSecurityGroupName -> (строка)

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

Status -> (строка)

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

VpcSecurityGroups -> (список)

Список групп безопасности Amazon Virtual Private Cloud (Amazon VPC), связанных с кластером. Этот параметр возвращается только если кластер находится в VPC.

(структура)

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

VpcSecurityGroupId -> (строка)

Идентификатор группы безопасности VPC.

Status -> (строка)

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

ClusterParameterGroups -> (список)

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

(структура)

Описание статуса группы параметров.

ParameterGroupName -> (строка)

Имя группы параметров кластера.

ParameterApplyStatus -> (строка)

Статус применения параметров.

ClusterParameterStatusList -> (список)

Список статусов параметров.

Для получения дополнительной информации о параметрах и группах параметров, см. Amazon Redshift Parameter Groups в руководстве Amazon Redshift Cluster Management Guide.

(структура)

Описание статуса группы параметров.

ParameterName -> (строка)

Имя параметра.

ParameterApplyStatus -> (строка)

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

Возможные статусы и описания:

  • in-sync : Значение параметра синхронизировано с базой данных.
  • pending-reboot : Значение параметра будет применено после перезагрузки кластера.
  • applying : Значение параметра применяется к базе данных.
  • invalid-parameter : Невозможно применить значение параметра, так как оно имеет недопустимое значение или синтаксис.
  • apply-deferred : Параметр содержит статические изменения свойств. Изменения откладываются до перезагрузки кластера.
  • apply-error : Невозможно подключиться к кластеру. Изменение параметра будет применено после перезагрузки кластера.
  • unknown-error : В данный момент невозможно применить изменение параметра. Изменение будет применено после перезагрузки кластера.

ParameterApplyErrorDescription -> (строка)

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

ClusterSubnetGroupName -> (строка)

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

VpcId -> (строка)

Идентификатор VPC, в котором находится кластер, если кластер находится в VPC.

AvailabilityZone -> (строка)

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

PreferredMaintenanceWindow -> (строка)

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

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

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

MasterUserPassword -> (строка)

Ожидаемое или текущее изменение пароля административного пользователя кластера.

NodeType -> (строка)

Ожидаемое или текущее изменение типа узла кластера.

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

Ожидаемое или текущее изменение количества узлов в кластере.

ClusterType -> (строка)

Ожидаемое или текущее изменение типа кластера.

ClusterVersion -> (строка)

Ожидаемое или текущее изменение версии сервиса.

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

Ожидаемое или текущее изменение срока хранения автоматических снимков.

ClusterIdentifier -> (строка)

Ожидаемое или текущее изменение нового идентификатора кластера.

PubliclyAccessible -> (булево)

Ожидаемое или текущее изменение возможности подключения к кластеру из общедоступной сети.

EnhancedVpcRouting -> (булево)

Параметр, указывающий, следует ли создать кластер с включенным расширенным маршрутизацией VPC. Для создания кластера, использующего расширенную маршрутизацию VPC, кластер должен находиться в VPC. Более подробная информация в руководстве Amazon Redshift Cluster Management Guide.

Если этот параметр равен true, расширенная маршрутизация VPC включена.

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

MaintenanceTrackName -> (строка)

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

EncryptionType -> (строка)

Тип шифрования для кластера. Возможные значения: KMS и None.

ClusterVersion -> (строка)

Идентификатор версии движка Amazon Redshift, работающего в кластере.

AllowVersionUpgrade -> (булево)

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

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

Количество вычислительных узлов в кластере.

PubliclyAccessible -> (булево)

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

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

Encrypted -> (булево)

Булево значение, которое, если true, указывает, что данные в кластере зашифрованы при хранении.

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

Значение, описывающее статус действия восстановления кластера. Этот параметр возвращает null, если кластер не был создан путем восстановления снимка.

Статус -> (строка)

Статус действия восстановления. Возвращает начато, восстанавливается, завершено или неудачно.

ТекущаяСкоростьВосстановленияВМегабайтахВСекунду -> (двойное)

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

РазмерСнимкаВМегабайтах -> (длинное)

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

ПрогрессВМегабайтах -> (длинное)

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

ВремяВСекундах -> (длинное)

Время выполнения текущего процесса восстановления или время, необходимое для завершения завершенного восстановления. Это поле обновляется только при восстановлении на узлы типа DC2.

ОжидаемоеВремяДоЗавершенияВСекундах -> (длинное)

Ожидаемое время, оставшееся до завершения восстановления. Возвращает 0 для завершенного восстановления. Это поле обновляется только при восстановлении на узлы типа DC2.

ПрогрессПередачиДанных -> (структура)

Статус -> (строка)

Описывает статус кластера. Пока передача данных продолжается, статус равен transferringdata.

ТекущаяСкоростьВМегабайтахВСекунду -> (двойное)

Описывает скорость передачи данных в МБ/сек.

ОбщийОбъемДанныхВМегабайтах -> (длинное)

Описывает общий объем данных, подлежащих передаче, в мегабайтах.

ПереданныеДанныеВМегабайтах -> (длинное)

Описывает общий объем данных, которые были переданы, в МБ.

ОжидаемоеВремяДоЗавершенияВСекундах -> (длинное)

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

ВремяВСекундах -> (длинное)

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

СтатусHsm -> (структура)

Значение, которое сообщает, завершил ли кластер Amazon Redshift применение любых изменений параметров модуля аппаратной безопасности (HSM), указанных в команде модификации кластера.

Значения: active, applying

ИдентификаторСертификатаКлиентаHsm -> (строка)

Указывает имя сертификата клиента HSM, используемого кластером Amazon Redshift для получения ключей шифрования данных, хранящихся в HSM.

ИдентификаторКонфигурацииHsm -> (строка)

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

Статус -> (строка)

Сообщает, завершил ли кластер Amazon Redshift применение любых изменений параметров HSM, указанных в команде модификации кластера.

Значения: active, applying

СтатусКопииСнимокКластера -> (структура)

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

ЦелевойРегион -> (строка)

Целевой регион, в который автоматически копируются снимки при включенном межрегиональном копировании снимков.

СрокХранения -> (длинное)

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

СрокХраненияСнимокВручную -> (целое)

Количество дней, в течение которых автоматические снимки хранятся в целевом регионе после копирования из исходного региона. Если значение равно -1, ручной снимок хранится неопределенно.

Значение должно быть либо -1, либо целым числом от 1 до 3653.

ИмяРазрешенияНаКопированиеСнимков -> (строка)

Название разрешения на копирование снимка.

ОткрытыйКлючКластера -> (строка)

Открытый ключ кластера.

УзлыКластера -> (список)

Узлы в кластере.

(структура)

Идентификатор узла в кластере.

РольУзла -> (строка)

Является ли узел лидером или вычислительным узлом.

ПриватныйIP-адрес -> (строка)

Приватный IP-адрес узла в кластере.

ПубличныйIP-адрес -> (строка)

Публичный IP-адрес узла в кластере.

СтатусElasticIp -> (структура)

Статус эластичного IP-адреса (EIP).

ElasticIp -> (строка)

Эластичный IP-адрес (EIP) для кластера.

Статус -> (строка)

Статус эластичного IP-адреса (EIP).

НомерРевизииКластера -> (строка)

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

Теги -> (список)

Список тегов для кластера.

(структура)

Тег, состоящий из пары имя/значение для ресурса.

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

Ключ или имя тега ресурса.

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

Значение тега ресурса.

ИдентификаторKmsКлюча -> (строка)

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

УлучшенноеVPCМаршрутирование -> (булево)

Параметр, указывающий, нужно ли создавать кластер с включенным улучшенным маршрутизацией VPC. Для создания кластера, использующего улучшенное VPC маршрутирование, кластер должен находиться в VPC. Дополнительная информация приведена в разделе Улучшенное VPC маршрутирование в руководстве по управлению кластерами Amazon Redshift.

Если этот параметр true, улучшенное VPC маршрутирование включено.

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

РолиIam -> (список)

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

(структура)

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

IamRoleArn -> (строка)

Amazon Resource Name (ARN) роли IAM, например, arn:aws:iam::123456789012:role/RedshiftCopyUnload.

СтатусПрименения -> (строка)

Значение, описывающее статус ассоциации роли IAM с кластером Amazon Redshift.

Возможные статусы и описания:

  • in-sync: Роль доступна для использования кластером.
  • adding: Роль находится в процессе ассоциации с кластером.
  • removing: Роль находится в процессе отсоединения от кластера.

ОжидаемыеДействия -> (список)

Операции кластера, ожидающие запуска.

(строка)

ИмяПланаТехническогоОбслуживания -> (строка)

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

ElasticResizeКоличествоУзловВарианты -> (строка)

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

ОтложенныеОкнаТехническогоОбслуживания -> (список)

Описывает группу объектов DeferredMaintenanceWindow.

(структура)

Описывает окно отложенного технического обслуживания

ИдентификаторОтложенногоТехническогоОбслуживания -> (строка)

Уникальный идентификатор окна технического обслуживания.

ВремяНачалаОтложенногоТехническогоОбслуживания -> (метка времени)

Метка времени начала периода, когда мы откладываем техническое обслуживание.

ВремяОкончанияОтложенногоТехническогоОбслуживания -> (метка времени)

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

ИдентификаторГрафикаСнимков -> (строка)

Уникальный идентификатор графика снимков кластера.

СостояниеГрафикаСнимков -> (строка)

Текущее состояние графика снимков кластера.

ОжидаемоеВремяСледующегоГрафикаСнимков -> (метка времени)

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

СтатусОжидаемогоСледующегоГрафикаСнимков -> (строка)

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

  • ВПлане - Следующий снимок ожидается в запланированное время.
  • Ожидание - Следующий снимок ожидает создания.

ВремяНачалаСледующегоОкнаТехническогоОбслуживания -> (метка времени)

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

ИнформацияОИзмененииМасштаба -> (структура)

Возвращает следующее:

  • AllowCancelResize: булево значение, указывающее, можно ли отменить операцию изменения масштаба.
  • ResizeType: Возвращает ClassicResize

ResizeType -> (строка)

Возвращает значение ClassicResize.

AllowCancelResize -> (булево)

Булево значение, указывающее, можно ли отменить операцию изменения масштаба.

СтатусПеремещенияВЗонУДоступности -> (строка)

Описывает статус операции перемещения в зону доступности.

ArnПространстваИменКластера -> (строка)

ARN пространства имен кластера.

ОбщаяЕмкостьХранилищаВМегабайтах -> (длинное)

Общая емкость хранилища кластера в мегабайтах.

КонфигурацияAqua -> (структура)

Это поле устарело. Amazon Redshift автоматически определяет, следует ли использовать AQUA (Advanced Query Accelerator).

СтатусAqua -> (строка)

Это поле устарело. Amazon Redshift автоматически определяет, следует ли использовать AQUA (Advanced Query Accelerator).

СтатусКонфигурацииAqua -> (строка)

Это поле устарело. Amazon Redshift автоматически определяет, следует ли использовать AQUA (Advanced Query Accelerator).

ArnРолиIamПоУмолчанию -> (строка)

Amazon Resource Name (ARN) для роли IAM, установленной по умолчанию для кластера.

СтатусОбменаЗарезервированнымиУзлами -> (структура)

Статус запроса обмена зарезервированными узлами. Статусы включают в себя выполняется и запрошен.

ИдентификаторЗапросаОбменаЗарезервированнымиУзлами -> (строка)

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

Статус -> (строка)

Статус запроса обмена зарезервированными узлами. Статусы включают в себя выполняется и запрошен.

ВремяЗапроса -> (метка времени)

Дата и время, указывающие на то, когда был запрошен обмен зарезервированными узлами.

ИдентификаторИсходногоЗарезервированногоУзла -> (строка)

Идентификатор исходного зарезервированного узла.

ТипИсходногоЗарезервированногоУзла -> (строка)

Тип исходного зарезервированного узла, например ra3.4xlarge.

КоличествоИсходныхЗарезервированныхУзлов -> (целое)

Количество исходных зарезервированных узлов в кластере.

ИдентификаторПредложенияЗарезервированногоУзлаЦели -> (строка)

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

ТипЦелевогоЗарезервированногоУзла -> (строка)

Тип узла целевого зарезервированного узла, например ra3.4xlarge.

КоличествоЦелевыхЗарезервированныхУзлов -> (целое)

Количество целевых зарезервированных узлов в кластере.

ПользовательскоеДоменноеИмя -> (строка)

Пользовательское доменное имя, связанное с кластером.

ПользовательскийДоменныйСертификатArn -> (строка)

Сертификат Amazon Resource Name (ARN) для пользовательского доменного имени.

СрокДействияПользовательскогоДоменногоСертификата -> (метка времени)

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

MasterPasswordSecretArn -> (string)

Идентификатор ресурса Amazon (ARN) секрета учетных данных администратора кластера.

MasterPasswordSecretKmsKeyId -> (string)

Идентификатор ключа управления ключами (KMS) используемого для шифрования и хранения секрета учетных данных администратора кластера.

IpAddressType -> (string)

Тип IP-адреса для кластера. Возможные значения — ipv4 и dualstack.

MultiAZ -> (string)

Логическое значение, которое, если равно true, указывает, что кластер развернут в двух зонах доступности.

MultiAZSecondary -> (structure)

Второе вычислительное устройство кластера, если включено многозонное развертывание.

AvailabilityZone -> (string)

Название зоны доступности, в которой расположено вторичное вычислительное устройство кластера.

ClusterNodes -> (list)

Узлы во вторичном вычислительном устройстве.

(structure)

Идентификатор узла в кластере.

NodeRole -> (string)

Является ли узел узлом-лидером или вычислительным узлом.

PrivateIPAddress -> (string)

Приватный IP-адрес узла в кластере.

PublicIPAddress -> (string)

Публичный IP-адрес узла в кластере.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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