Spec-Zone.ru › AWS CLI v2

[ aws . redshift-serverless ]

create-workgroup

Описание

Создает рабочую группу в Amazon Redshift Serverless.

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

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

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

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

Синтаксис

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

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

Имя пространства имён для ассоциации с рабочей группой.

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

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

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

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

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

Целевой уровень соотношения цены и производительности для рабочей группы. Допустимые значения: 1, 25, 50, 75 и 100. Соответствуют уровням соотношения цены и производительности НИЗКАЯ_СТОИМОСТЬ, ЭКОНОМИЧНЫЙ, СБАЛАНСИРОВАННЫЙ, РЕСУРСОЭФФЕКТИВНЫЙ и ВЫСОКАЯ_ПРОИЗВОДИТЕЛЬНОСТЬ.

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

--tags (список)

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

(структура)

Словарь пар ключ-значение.

key -> (строка)

Ключ для тега.

value -> (строка)

Значение тега.

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

key=string,value=string ...

Синтаксис JSON:

[
  {
    "key": "string",
    "value": "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.

Вывод

рабочая группа -> (структура)

Созданный объект рабочей группы.

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

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

configParameters -> (список)

Массив параметров для настройки расширенного управления базой данных. Доступные параметры: 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 -> (строка)

Значение настраиваемого параметра.

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

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

crossAccountVpcs -> (список)

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

(строка)

customDomainCertificateArn -> (строка)

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

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

Дата истечения срока действия сертификата.

customDomainName -> (строка)

Настраиваемое доменное имя, связанное с рабочей группой.

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

Точка подключения, созданная из рабочей группы.

address -> (строка)

DNS-адрес точки подключения VPC.

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

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

vpcEndpoints -> (список)

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

(структура)

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

networkInterfaces -> (список)

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

(структура)

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

availabilityZone -> (строка)

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

ipv6Address -> (строка)

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

networkInterfaceId -> (строка)

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

privateIpAddress -> (строка)

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

subnetId -> (строка)

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

vpcEndpointId -> (строка)

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

vpcId -> (строка)

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

enhancedVpcRouting -> (булево)

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

ipAddressType -> (строка)

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

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

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

namespaceName -> (строка)

Имя пространства имен, к которому относится рабочая группа.

patchVersion -> (строка)

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

pendingTrackName -> (строка)

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

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

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

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

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

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

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

status -> (строка)

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

publiclyAccessible -> (булево)

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

securityGroupIds -> (список)

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

(строка)

status -> (строка)

Статус рабочей группы.

subnetIds -> (список)

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

(строка)

trackName -> (строка)

Имя траектории для рабочей группы.

workgroupArn -> (строка)

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

workgroupId -> (строка)

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

workgroupName -> (строка)

Имя рабочей группы.

workgroupVersion -> (строка)

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

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

Spec-Zone.ru

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