interface CfnWorkgroupProps

Language	Type name
.NET	`Amazon.CDK.AWS.RedshiftServerless.CfnWorkgroupProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsredshiftserverless#CfnWorkgroupProps`
Java	`software.amazon.awscdk.services.redshiftserverless.CfnWorkgroupProps`
Python	`aws_cdk.aws_redshiftserverless.CfnWorkgroupProps`
TypeScript	`aws-cdk-lib` » `aws_redshiftserverless` » `CfnWorkgroupProps`

Properties for defining a CfnWorkgroup.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_redshiftserverless as redshiftserverless } from 'aws-cdk-lib';
const cfnWorkgroupProps: redshiftserverless.CfnWorkgroupProps = {
  workgroupName: 'workgroupName',

  // the properties below are optional
  baseCapacity: 123,
  configParameters: [{
    parameterKey: 'parameterKey',
    parameterValue: 'parameterValue',
  }],
  enhancedVpcRouting: false,
  maxCapacity: 123,
  namespaceName: 'namespaceName',
  port: 123,
  publiclyAccessible: false,
  securityGroupIds: ['securityGroupIds'],
  subnetIds: ['subnetIds'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
workgroupName	`string`	The name of the workgroup.
baseCapacity?	`number`	The base compute capacity of the workgroup in Redshift Processing Units (RPUs).
configParameters?	`IResolvable` `\|` `IResolvable` `\|` `ConfigParameterProperty[]`	A list of parameters to set for finer control over a database.
enhancedVpcRouting?	`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.
maxCapacity?	`number`	The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries.
namespaceName?	`string`	The namespace the workgroup is associated with.
port?	`number`	The custom port to use when connecting to a workgroup.
publiclyAccessible?	`boolean \|` `IResolvable`	A value that specifies whether the workgroup can be accessible from a public network.
securityGroupIds?	`string[]`	A list of security group IDs to associate with the workgroup.
subnetIds?	`string[]`	A list of subnet IDs the workgroup is associated with.
tags?	`CfnTag[]`	The map of the key-value pairs used to tag the workgroup.

workgroupName

Type: string

The name of the workgroup.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-workgroupname

baseCapacity?

Type: number (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-basecapacity

configParameters?

Type: IResolvable | IResolvable | ConfigParameterProperty[] (optional)

A list of parameters to set for finer control over a database.

Available options are datestyle , enable_user_activity_logging , query_group , search_path , max_query_execution_time , and require_ssl .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-configparameters

enhancedVpcRouting?

Type: boolean | IResolvable (optional, default: false)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-enhancedvpcrouting