Workgroup

The collection of computing resources from which an endpoint is created.

baseCapacity

The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).

Type: Integer

Required: No

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.

Type: Array of ConfigParameter objects

Required: No

creationDate

The creation date of the workgroup.

Type: Timestamp

Required: No

crossAccountVpcs

A list of VPCs. Each entry is the unique identifier of a virtual private cloud with access to Amazon Redshift Serverless. If all of the VPCs for the grantee are allowed, it shows an asterisk.

Type: Array of strings

Required: No

customDomainCertificateArn

The custom domain name’s certificate Amazon resource name (ARN).

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:[\w+=/,.@-]+:acm:[\w+=/,.@-]*:[0-9]+:[\w+=,.@-]+(/[\w+=,.@-]+)*

Required: No

customDomainCertificateExpiryTime

The expiration time for the certificate.

Type: Timestamp

Required: No

customDomainName

The custom domain name associated with the workgroup.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 253.

Pattern: ^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])$

Required: No

endpoint

The endpoint that is created from the workgroup.

Type: Endpoint object

Required: No

enhancedVpcRouting

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

Type: Boolean

Required: No

ipAddressType

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

Type: String

Pattern: ^(ipv4|dualstack)$

Required: No

maxCapacity

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

Type: Integer

Required: No

namespaceName

The namespace the workgroup is associated with.

Type: String

Required: No

patchVersion

The patch version of your Amazon Redshift Serverless workgroup. For more information about patch versions, see Cluster versions for Amazon Redshift.

Type: String

Required: No

port

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

Type: Integer

Required: No

pricePerformanceTarget

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

Type: PerformanceTarget object

Required: No

publiclyAccessible

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

Type: Boolean

Required: No

securityGroupIds

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

Type: Array of strings

Required: No

status

The status of the workgroup.

Type: String

Valid Values: CREATING | AVAILABLE | MODIFYING | DELETING

Required: No

subnetIds

An array of subnet IDs the workgroup is associated with.

Type: Array of strings

Required: No

workgroupArn

The Amazon Resource Name (ARN) that links to the workgroup.

Type: String

Required: No

workgroupId

The unique identifier of the workgroup.

Type: String

Required: No

workgroupName

The name of the workgroup.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 64.

Pattern: ^[a-z0-9-]+$

Required: No

workgroupVersion

The Amazon Redshift Serverless version of your workgroup. For more information about Amazon Redshift Serverless versions, seeCluster versions for Amazon Redshift.

Type: String

Required: No

Workgroup

Contents

See Also