Spec-Zone.ru › AWS CLI v2

[ aws . redshift-serverless ]

update-workgroup

Описание

Обновляет рабочую группу с указанными настройками конфигурации. Вы не можете обновить несколько параметров в одном запросе. Например, вы можете обновить baseCapacity или port в одном запросе, но не оба в одном запросе.

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

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

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

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

Синтаксис

  update-workgroup
[--base-capacity <value>]
[--config-parameters <value>]
[--enhanced-vpc-routing | --no-enhanced-vpc-routing]
[--ip-address-type <value>]
[--max-capacity <value>]
[--port <value>]
[--price-performance-target <value>]
[--publicly-accessible | --no-publicly-accessible]
[--security-group-ids <value>]
[--subnet-ids <value>]
[--track-name <value>]
--workgroup-name <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]

Параметры

--base-capacity (целое число)

Новая базовая емкость хранилища данных в Redshift Processing Units (RPUs).

--config-parameters (список)

Массив параметров для настройки расширенного управления базой данных. Параметры: auto_mv , datestyle , enable_case_sensitive_identifier , enable_user_activity_logging , query_group , search_path , require_ssl , use_fips_ssl , и метрики мониторинга запросов, которые позволяют определять границы производительности. Дополнительную информацию о правилах мониторинга запросов и доступных метриках см. в разделе «Метрики мониторинга запросов для Amazon Redshift Serverless».

(структура)

Массив пар ключ-значение для настройки расширенного управления Amazon Redshift Serverless.

parameterKey -> (строка)

Ключ параметра. Доступны значения: auto_mv , datestyle , enable_case_sensitive_identifier , enable_user_activity_logging , query_group , search_path , require_ssl , use_fips_ssl и метрики мониторинга запросов, позволяющие определять границы производительности. Дополнительную информацию о правилах мониторинга запросов и доступных метриках см. в разделе «Метрики мониторинга запросов для Amazon Redshift Serverless».

parameterValue -> (строка)

Значение параметра для настройки.

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

parameterKey=string,parameterValue=string ...

Синтаксис JSON:

[
  {
    "parameterKey": "string",
    "parameterValue": "string"
  }
  ...
]

--enhanced-vpc-routing | --no-enhanced-vpc-routing (логическое значение)

Значение, определяющее включение расширенного маршрутизации виртуальной частной сети (VPC), которое заставляет Amazon Redshift Serverless маршрутизировать трафик через вашу VPC.

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

Тип IP-адреса, поддерживаемый рабочей группой. Возможные значения: ipv4 и dualstack.

--max-capacity (целое число)

Максимальная емкость хранилища данных, которую Amazon Redshift Serverless использует для обработки запросов. Максимальная емкость указывается в RPUs.

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

Пользовательский порт для подключения к рабочей группе. Допустимый диапазон портов 5431-5455 и 8191-8215. По умолчанию используется порт 5439.

--price-performance-target (структура)

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

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

Целевой уровень производительности и цены для рабочей группы. Допустимые значения: 1, 25, 50, 75 и 100. Они соответствуют уровням производительности и цены: LOW_COST, ECONOMICAL, BALANCED, RESOURCEFUL и HIGH_PERFORMANCE.

status -> (строка)

Включен ли целевой уровень производительности и цены для рабочей группы.

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

level=integer,status=string

Синтаксис JSON:

{
  "level": integer,
  "status": "ENABLED"|"DISABLED"
}

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

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

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

Массив идентификаторов групп безопасности, которые необходимо ассоциировать с рабочей группой.

(строка)

Синтаксис:

"string" "string" ...

--subnet-ids (список)

Массив идентификаторов подсетей VPC, которые необходимо ассоциировать с рабочей группой.

(строка)

Синтаксис:

"string" "string" ...

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

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

--workgroup-name (строка)

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

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

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

--cli-connect-timeout (int)

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

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

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

  • base64
  • raw-in-base64-out

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

Отключить вывод с помощью пейджера.

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

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

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

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

Вывод

группа -> (структура)

Обновлённый объект группы.

базоваяЁмкость -> (целое число)

Базовая ёмкость хранилища данных группы в Redshift Processing Units (RPUs).

параметрыКонфигурации -> (список)

Массив параметров для настройки расширенного управления базой данных. Доступные варианты: auto_mv , datestyle , enable_case_sensitive_identifier , enable_user_activity_logging , query_group , search_path , require_ssl , use_fips_ssl и метрики мониторинга запросов, которые позволяют определить границы производительности. Для получения дополнительной информации о правилах мониторинга запросов и доступных метриках, см. Метрики мониторинга запросов для Amazon Redshift Serverless.

(структура)

Массив пар ключ-значение для настройки расширенного управления Amazon Redshift Serverless.

ключПараметра -> (строка)

Ключ параметра. Доступные варианты: auto_mv , datestyle , enable_case_sensitive_identifier , enable_user_activity_logging , query_group , search_path , require_ssl , use_fips_ssl и метрики мониторинга запросов, которые позволяют определить границы производительности. Для получения дополнительной информации о правилах мониторинга запросов и доступных метриках, см. Метрики мониторинга запросов для Amazon Redshift Serverless.

значениеПараметра -> (строка)

Значение параметра для настройки.

датаСоздание -> (временная метка)

Дата создания группы.

межсетевыеVPC -> (список)

Список VPC. Каждый элемент — уникальный идентификатор виртуальной частной сети с доступом к Amazon Redshift Serverless. Если все VPC для уполномоченного пользователя разрешены, отображается звездочка.

(строка)

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

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

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

Время истечения сертификата.

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

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

конечнаяТочка -> (структура)

Конечная точка, созданная из группы.

адрес -> (строка)

DNS-адрес VPC-конечной точки.

порт -> (целое число)

Порт, на котором Amazon Redshift Serverless прослушивает запросы.

vpcКонечныеТочки -> (список)

Массив объектов VpcEndpoint.

(структура)

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

интерфейсныеКарты -> (список)

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

(структура)

Содержит информацию о сетевом интерфейсе в управляемой VPC-конечной точке Amazon Redshift Serverless.

зонаДоступности -> (строка)

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

адресIpv6 -> (строка)

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

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

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

приватныйАдресIp -> (строка)

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

идентификаторПодсети -> (строка)

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

идентификаторVpcКонечнойТочки -> (строка)

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

идентификаторVpc -> (строка)

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

улучшенноеМаршрутизацияVpc -> (булево)

Значение, определяющее включение улучшенного маршрутирования виртуальной частной сети (VPC), которое принуждает Amazon Redshift Serverless к маршрутизации трафика через вашу VPC.

типАдресаIp -> (строка)

Тип IP-адреса, поддерживаемый группой. Возможные значения: ipv4 и dualstack.

максимальнаяЁмкость -> (целое число)

Максимальная ёмкость хранилища данных, используемая Amazon Redshift Serverless для обработки запросов. Максимальная ёмкость указывается в RPUs.

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

Пространство имён, к которому относится группа.

версияОбновления -> (строка)

Версия обновления вашей группы Amazon Redshift Serverless. Для получения дополнительной информации о версиях обновлений см. Версии кластеров для Amazon Redshift.

названиеОжидаемогоТрэка -> (строка)

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

порт -> (целое число)

Настраиваемый порт для подключения к группе. Допустимый диапазон портов — 5431-5455 и 8191-8215. По умолчанию используется 5439.

цельЦенаПроизводительность -> (структура)

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

уровень -> (целое число)

Уровень цели цены и производительности для группы. Допустимые значения: 1, 25, 50, 75 и 100. Они соответствуют уровням цены и производительности LOW_COST, ECONOMICAL, BALANCED, RESOURCEFUL и HIGH_PERFORMANCE.

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

Включена ли цель цены и производительности для группы.

общедоступная -> (булево)

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

идентификаторыГруппыБезопасности -> (список)

Массив идентификаторов групп безопасности, которые необходимо ассоциировать с группой.

(строка)

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

Состояние группы.

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

Массив идентификаторов подсетей, связанных с группой.

(строка)

имяТрэка -> (строка)

Имя трэка для группы.

arnГруппы -> (строка)

Amazon Resource Name (ARN), связанный с группой.

идентификаторГруппы -> (строка)

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

имяГруппы -> (строка)

Название группы.

версияГруппы -> (строка)

Версия Amazon Redshift Serverless для вашей группы. Дополнительную информацию о версиях Amazon Redshift Serverless см. в разделе `Версии кластеров для Amazon Redshift `__.

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

Spec-Zone.ru

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