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,
  pricePerformanceTarget: {
    level: 123,
    status: 'status',
  },
  publiclyAccessible: false,
  recoveryPointId: 'recoveryPointId',
  securityGroupIds: ['securityGroupIds'],
  snapshotArn: 'snapshotArn',
  snapshotName: 'snapshotName',
  snapshotOwnerAccount: 'snapshotOwnerAccount',
  subnetIds: ['subnetIds'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  trackName: 'trackName',
  workgroup: {
    baseCapacity: 123,
    configParameters: [{
      parameterKey: 'parameterKey',
      parameterValue: 'parameterValue',
    }],
    creationDate: 'creationDate',
    endpoint: {
      address: 'address',
      port: 123,
      vpcEndpoints: [{
        networkInterfaces: [{
          availabilityZone: 'availabilityZone',
          networkInterfaceId: 'networkInterfaceId',
          privateIpAddress: 'privateIpAddress',
          subnetId: 'subnetId',
        }],
        vpcEndpointId: 'vpcEndpointId',
        vpcId: 'vpcId',
      }],
    },
    enhancedVpcRouting: false,
    maxCapacity: 123,
    namespaceName: 'namespaceName',
    pricePerformanceTarget: {
      level: 123,
      status: 'status',
    },
    publiclyAccessible: false,
    securityGroupIds: ['securityGroupIds'],
    status: 'status',
    subnetIds: ['subnetIds'],
    trackName: 'trackName',
    workgroupArn: 'workgroupArn',
    workgroupId: 'workgroupId',
    workgroupName: 'workgroupName',
  },
};

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)[]`	The key of the parameter.
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.
pricePerformanceTarget?	`IResolvable` `\|` `PerformanceTargetProperty`	An object that represents the price performance target settings for the workgroup.
publiclyAccessible?	`boolean \|` `IResolvable`	A value that specifies whether the workgroup can be accessible from a public network.
recoveryPointId?	`string`	The recovery point id to restore from.
securityGroupIds?	`(string \|` `ISecurityGroupRef)[]`	A list of security group IDs to associate with the workgroup.
snapshotArn?	`string`	The Amazon Resource Name (ARN) of the snapshot to restore from.
snapshotName?	`string`	The snapshot name to restore from.
snapshotOwnerAccount?	`string`	The Amazon Web Services account that owns the snapshot.
subnetIds?	`(string \|` `ISubnetRef)[]`	A list of subnet IDs the workgroup is associated with.
tags?	`CfnTag[]`	The map of the key-value pairs used to tag the workgroup.
trackName?	`string`	An optional parameter for the name of the track for the workgroup.
workgroup?	`IResolvable` `\|` `WorkgroupProperty`	The collection of computing resources from which an endpoint is created.

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)

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 .

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