Update Workgroup

redshiftserverless_update_workgroup

R Documentation

Updates a workgroup with the specified configuration settings

Description

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.

VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. If a workgroup is in an account with VPC BPA turned on, the following capabilities are blocked:

• Creating a public access workgroup

• Modifying a private workgroup to public

• Adding a subnet with VPC BPA turned on to the workgroup when the workgroup is public

For more information about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.

Usage

redshiftserverless_update_workgroup(baseCapacity, configParameters,
  enhancedVpcRouting, ipAddressType, maxCapacity, port,
  pricePerformanceTarget, publiclyAccessible, securityGroupIds, subnetIds,
  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 query monitoring metrics that let you define performance boundaries. 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.
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.
workgroupName	[required] The name of the workgroup to update. You can't update the name of a workgroup once it is created.

Value

A list with the following syntax:

list(
  workgroup = list(
    baseCapacity = 123,
    configParameters = list(
      list(
        parameterKey = "string",
        parameterValue = "string"
      )
    ),
    creationDate = as.POSIXct(
      "2015-01-01"
    ),
    crossAccountVpcs = list(
      "string"
    ),
    customDomainCertificateArn = "string",
    customDomainCertificateExpiryTime = as.POSIXct(
      "2015-01-01"
    ),
    customDomainName = "string",
    endpoint = list(
      address = "string",
      port = 123,
      vpcEndpoints = list(
        list(
          networkInterfaces = list(
            list(
              availabilityZone = "string",
              ipv6Address = "string",
              networkInterfaceId = "string",
              privateIpAddress = "string",
              subnetId = "string"
            )
          ),
          vpcEndpointId = "string",
          vpcId = "string"
        )
      )
    ),
    enhancedVpcRouting = TRUE|FALSE,
    ipAddressType = "string",
    maxCapacity = 123,
    namespaceName = "string",
    patchVersion = "string",
    port = 123,
    pricePerformanceTarget = list(
      level = 123,
      status = "ENABLED"|"DISABLED"
    ),
    publiclyAccessible = TRUE|FALSE,
    securityGroupIds = list(
      "string"
    ),
    status = "CREATING"|"AVAILABLE"|"MODIFYING"|"DELETING",
    subnetIds = list(
      "string"
    ),
    workgroupArn = "string",
    workgroupId = "string",
    workgroupName = "string",
    workgroupVersion = "string"
  )
)

Request syntax

svc$update_workgroup(
  baseCapacity = 123,
  configParameters = list(
    list(
      parameterKey = "string",
      parameterValue = "string"
    )
  ),
  enhancedVpcRouting = TRUE|FALSE,
  ipAddressType = "string",
  maxCapacity = 123,
  port = 123,
  pricePerformanceTarget = list(
    level = 123,
    status = "ENABLED"|"DISABLED"
  ),
  publiclyAccessible = TRUE|FALSE,
  securityGroupIds = list(
    "string"
  ),
  subnetIds = list(
    "string"
  ),
  workgroupName = "string"
)