AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::RedshiftServerless::Workgroup

CfnWorkgroup

The collection of compute resources in Amazon Redshift Serverless.

Import

import { CfnWorkgroup } from 'aws-cdk-lib/aws-redshiftserverless';

Or use the module namespace:

import * as redshiftserverless from 'aws-cdk-lib/aws-redshiftserverless';
// redshiftserverless.CfnWorkgroup

Properties

Configuration passed to the constructor as CfnWorkgroupProps.

workgroupNameRequired
string

The name of the workgroup.

baseCapacityOptional
number

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

configParametersOptional
IResolvable | IResolvable | ConfigParameterProperty[]

The key of the parameter. 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](https://docs.aws.amazon.com/redshift/latest/dg/cm-c-wlm-query-monitoring-rules.html#cm-c-wlm-query-monitoring-metrics-serverless) .

enhancedVpcRoutingOptional
boolean | IResolvable

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

Default: - false

maxCapacityOptional
number

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

namespaceNameOptional
string

The namespace the workgroup is associated with.

portOptional
number

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

pricePerformanceTargetOptional
IResolvable | PerformanceTargetProperty

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

publiclyAccessibleOptional
boolean | IResolvable

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

Default: - false

recoveryPointIdOptional
string

The recovery point id to restore from.

securityGroupIdsOptional
string | ISecurityGroupRef[]

A list of security group IDs to associate with the workgroup.

snapshotArnOptional
string

The Amazon Resource Name (ARN) of the snapshot to restore from.

snapshotNameOptional
string

The snapshot name to restore from.

snapshotOwnerAccountOptional
string

The Amazon Web Services account that owns the snapshot.

subnetIdsOptional
string | ISubnetRef[]

A list of subnet IDs the workgroup is associated with.

tagsOptional
CfnTag[]

The map of the key-value pairs used to tag the workgroup.

trackNameOptional
string

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.

workgroupOptional
IResolvable | WorkgroupProperty

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

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::RedshiftServerless::WorkgroupView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-redshiftserverless
CFN TypeAWS::RedshiftServerless::Workgroup
Properties18

Related Constructs

Explore This Service

External Links