1.204.0

interface WorkgroupProperty

LanguageType name
.NETAmazon.CDK.AWS.RedshiftServerless.CfnWorkgroup.WorkgroupProperty
Javasoftware.amazon.awscdk.services.redshiftserverless.CfnWorkgroup.WorkgroupProperty
Pythonaws_cdk.aws_redshiftserverless.CfnWorkgroup.WorkgroupProperty
TypeScript @aws-cdk/aws-redshiftserverless » CfnWorkgroup » WorkgroupProperty

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

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 workgroupProperty: redshiftserverless.CfnWorkgroup.WorkgroupProperty = {
  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,
  namespaceName: 'namespaceName',
  publiclyAccessible: false,
  securityGroupIds: ['securityGroupIds'],
  status: 'status',
  subnetIds: ['subnetIds'],
  workgroupArn: 'workgroupArn',
  workgroupId: 'workgroupId',
  workgroupName: 'workgroupName',
};

Properties

NameTypeDescription
baseCapacity?numberThe base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
configParameters?IResolvable | ConfigParameterProperty | IResolvable[]An array of parameters to set for advanced control over a database.
creationDate?stringThe creation date of the workgroup.
endpoint?IResolvable | EndpointPropertyThe endpoint that is created from the workgroup.
enhancedVpcRouting?boolean | IResolvableThe value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
namespaceName?stringThe namespace the workgroup is associated with.
publiclyAccessible?boolean | IResolvableA value that specifies whether the workgroup can be accessible from a public network.
securityGroupIds?string[]An array of security group IDs to associate with the workgroup.
status?stringThe status of the workgroup.
subnetIds?string[]An array of subnet IDs the workgroup is associated with.
workgroupArn?stringThe Amazon Resource Name (ARN) that links to the workgroup.
workgroupId?stringThe unique identifier of the workgroup.
workgroupName?stringThe name of the workgroup.

baseCapacity?

Type: number (optional)

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

configParameters?

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

An array of parameters to set for advanced control over a database.

The options are auto_mv , datestyle , enable_case_sensitivity_identifier , enable_user_activity_logging , query_group , , search_path , 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 .

creationDate?

Type: string (optional)

The creation date of the workgroup.

endpoint?

Type: IResolvable | EndpointProperty (optional)

The endpoint that is created from the workgroup.

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.

publiclyAccessible?

Type: boolean | IResolvable (optional)

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

securityGroupIds?

Type: string[] (optional)

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

status?

Type: string (optional)

The status of the workgroup.

subnetIds?

Type: string[] (optional)

An array of subnet IDs the workgroup is associated with.

workgroupArn?

Type: string (optional)

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

workgroupId?

Type: string (optional)

The unique identifier of the workgroup.

workgroupName?

Type: string (optional)

The name of the workgroup.

← PreviousNext →