Skip to contents

Updates a workgroup with the specified configuration settings

Source: R/redshiftserverless_operations.R
redshiftserverless_update_workgroup.Rd

Updates a workgroup with the specified configuration settings. You can't update multiple parameters in one request. For example, you can update baseCapacity or port in a single request, but you can't update both in the same request.

See https://www.paws-r-sdk.com/docs/redshiftserverless_update_workgroup/ for full documentation.

Usage

redshiftserverless_update_workgroup(
  baseCapacity = NULL,
  configParameters = NULL,
  enhancedVpcRouting = NULL,
  extraComputeForAutomaticOptimization = NULL,
  ipAddressType = NULL,
  maxCapacity = NULL,
  port = NULL,
  pricePerformanceTarget = NULL,
  publiclyAccessible = NULL,
  securityGroupIds = NULL,
  subnetIds = NULL,
  trackName = NULL,
  workgroupName
)

Arguments

baseCapacity

The new base data warehouse capacity in Redshift Processing Units (RPUs).

configParameters

An array of parameters to set for advanced control over a database. The options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, and either wlm_json_configuration or query monitoring metrics that let you define performance boundaries. You can either specify individual query monitoring metrics (such as max_scan_row_count, max_query_execution_time) or use wlm_json_configuration to define query queues with rules, but not both. If you're using wlm_json_configuration, the maximum size of parameterValue is 8000 characters. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.

enhancedVpcRouting

The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.

extraComputeForAutomaticOptimization

If true, allocates additional compute resources for running automatic optimization operations.

Default: false

ipAddressType

The IP address type that the workgroup supports. Possible values are ipv4 and dualstack.

maxCapacity

The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.

port

The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.

pricePerformanceTarget

An object that represents the price performance target settings for the workgroup.

publiclyAccessible

A value that specifies whether the workgroup can be accessible from a public network.

securityGroupIds

An array of security group IDs to associate with the workgroup.

subnetIds

An array of VPC subnet IDs to associate with the workgroup.

trackName

An optional parameter for the name of the track for the workgroup. If you don't provide a track name, the workgroup is assigned to the current track.

workgroupName

[required] The name of the workgroup to update. You can't update the name of a workgroup once it is created.