interface CfnWorkgroupProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.RedshiftServerless.CfnWorkgroupProps |
Java | software.amazon.awscdk.services.redshiftserverless.CfnWorkgroupProps |
Python | aws_cdk.aws_redshiftserverless.CfnWorkgroupProps |
TypeScript | @aws-cdk/aws-redshiftserverless » CfnWorkgroupProps |
Properties for defining a CfnWorkgroup
.
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 cfnWorkgroupProps: redshiftserverless.CfnWorkgroupProps = {
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',
}],
};
Properties
Name | Type | Description |
---|---|---|
workgroup | string | The name of the workgroup. |
base | number | The base compute capacity of the workgroup in Redshift Processing Units (RPUs). |
config | IResolvable | Config | IResolvable [] | A list of parameters to set for finer control over a database. |
enhanced | 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. |
namespace | string | The namespace the workgroup is associated with. |
port? | number | The custom port to use when connecting to a workgroup. |
publicly | boolean | IResolvable | A value that specifies whether the workgroup can be accessible from a public network. |
security | string[] | A list of security group IDs to associate with the workgroup. |
subnet | string[] | A list of subnet IDs the workgroup is associated with. |
tags? | Cfn [] | 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
|
Config
|
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:
Cfn
[]
(optional)
The map of the key-value pairs used to tag the workgroup.