class CfnWorkgroup (construct)

Language	Type name
.NET	Amazon.CDK.AWS.RedshiftServerless.CfnWorkgroup
Java	software.amazon.awscdk.services.redshiftserverless.CfnWorkgroup
Python	aws_cdk.aws_redshiftserverless.CfnWorkgroup
TypeScript	@aws-cdk/aws-redshiftserverless » CfnWorkgroup

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::RedshiftServerless::Workgroup.

The collection of compute resources in Amazon Redshift Serverless.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as redshiftserverless from '@aws-cdk/aws-redshiftserverless';
const cfnWorkgroup = new redshiftserverless.CfnWorkgroup(this, 'MyCfnWorkgroup', {
  workgroupName: 'workgroupName',

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

Initializer

new CfnWorkgroup(scope: Construct, id: string, props: CfnWorkgroupProps)

Parameters

• scope Construct — - scope in which this resource is defined.
• id string — - scoped id of the resource.
• props CfnWorkgroupProps — - resource properties.

Create a new AWS::RedshiftServerless::Workgroup.

Construct Props

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 | ConfigParameterProperty | IResolvable[]	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.
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.

---

baseCapacity?

Type: number (optional)

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

---

configParameters?

Type: IResolvable | ConfigParameterProperty | IResolvable[] (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 , and max_query_execution_time .

---

enhancedVpcRouting?

Type: boolean | IResolvable (optional)

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

---

namespaceName?

Type: string (optional)

The namespace the workgroup is associated with.

---

port?

Type: number (optional)

The custom port to use when connecting to a workgroup.

Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.

---

publiclyAccessible?

Type: boolean | IResolvable (optional)

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

---

securityGroupIds?

Type: string[] (optional)

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

---

subnetIds?

Type: string[] (optional)

A list of subnet IDs the workgroup is associated with.

---

tags?

Type: CfnTag[] (optional)

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

Properties

Name	Type	Description
attrWorkgroupBaseCapacity	number	The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
attrWorkgroupConfigParameters	IResolvable
attrWorkgroupCreationDate	string	The creation date of the workgroup.
attrWorkgroupEndpointAddress	string	The DNS address of the VPC endpoint.
attrWorkgroupEndpointPort	number	The custom port to use when connecting to a workgroup.
attrWorkgroupEndpointVpcEndpoints	IResolvable
attrWorkgroupEnhancedVpcRouting	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.
attrWorkgroupNamespaceName	string	The namespace the workgroup is associated with.
attrWorkgroupPubliclyAccessible	IResolvable	A value that specifies whether the workgroup can be accessible from a public network.
attrWorkgroupSecurityGroupIds	string[]	An array of security group IDs to associate with the workgroup.
attrWorkgroupStatus	string	The status of the workgroup.
attrWorkgroupSubnetIds	string[]	An array of subnet IDs the workgroup is associated with.
attrWorkgroupWorkgroupArn	string	The Amazon Resource Name (ARN) that links to the workgroup.
attrWorkgroupWorkgroupId	string	The unique identifier of the workgroup.
attrWorkgroupWorkgroupName	string	The name of the workgroup.
cfnOptions	ICfnResourceOptions	Options for this resource, such as condition, update policy etc.
cfnProperties	{ [string]: any }
cfnResourceType	string	AWS resource type.
creationStack	string[]
logicalId	string	The logical ID for this CloudFormation stack element.
node	ConstructNode	The construct tree node associated with this construct.
ref	string	Return a string that will be resolved to a CloudFormation { Ref } for this element.
stack	Stack	The stack in which this element is defined.
tags	TagManager	The map of the key-value pairs used to tag the workgroup.
workgroupName	string	The name of the workgroup.
baseCapacity?	number	The base compute capacity of the workgroup in Redshift Processing Units (RPUs).
configParameters?	IResolvable | ConfigParameterProperty | IResolvable[]	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.
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.
static CFN_RESOURCE_TYPE_NAME	string	The CloudFormation resource type name for this resource class.

---

attrWorkgroupBaseCapacity

Type: number

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

---

attrWorkgroupConfigParameters

Type: IResolvable

---

attrWorkgroupCreationDate

Type: string

The creation date of the workgroup.

---

attrWorkgroupEndpointAddress

Type: string

The DNS address of the VPC endpoint.

---

attrWorkgroupEndpointPort

Type: number

The custom port to use when connecting to a workgroup.

Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.

---

attrWorkgroupEndpointVpcEndpoints

Type: IResolvable

---

attrWorkgroupEnhancedVpcRouting

Type: 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.

---

attrWorkgroupNamespaceName

Type: string

The namespace the workgroup is associated with.

---

attrWorkgroupPubliclyAccessible

Type: IResolvable

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

---

attrWorkgroupSecurityGroupIds

Type: string[]

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

---

attrWorkgroupStatus

Type: string

The status of the workgroup.

---

attrWorkgroupSubnetIds

Type: string[]

An array of subnet IDs the workgroup is associated with.

---

attrWorkgroupWorkgroupArn

Type: string

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

---

attrWorkgroupWorkgroupId

Type: string

The unique identifier of the workgroup.

---

attrWorkgroupWorkgroupName

Type: string

The name of the workgroup.

---

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

---

cfnProperties

Type: { [string]: any }

---

cfnResourceType

Type: string

AWS resource type.

---

creationStack

Type: string[]

---

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

---

node

Type: ConstructNode

The construct tree node associated with this construct.

---

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

---

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

---

tags

Type: TagManager

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

---

workgroupName

Type: string

The name of the workgroup.

---

baseCapacity?

Type: number (optional)

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

---

configParameters?

Type: IResolvable | ConfigParameterProperty | IResolvable[] (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 , and max_query_execution_time .

---

enhancedVpcRouting?

Type: boolean | IResolvable (optional)

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

---

namespaceName?

Type: string (optional)

The namespace the workgroup is associated with.

---

port?

Type: number (optional)

The custom port to use when connecting to a workgroup.

Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.

---

publiclyAccessible?

Type: boolean | IResolvable (optional)

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

---

securityGroupIds?

Type: string[] (optional)

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

---

subnetIds?

Type: string[] (optional)

A list of subnet IDs the workgroup is associated with.

---

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for addOverride(path, undefined).
addDependsOn(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

---

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

• path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

---

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

---

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

• key string
• value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

• path string — - The path of the property, you can use dot notation to override values in complex types.
• value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

---

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

• propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

---

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

• propertyPath string — The path of the property.
• value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

---

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

• policy RemovalPolicy
• options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

• attributeName string — The name of the attribute.

Returns

• Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

---

getMetadata(key)

public getMetadata(key: string): any

Parameters

• key string

Returns

• any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

• inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

---

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

• newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

• props { [string]: any }

Returns

• { [string]: any }