AWS::RedshiftServerless::Workgroup Workgroup

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "BaseCapacity" : Integer,
  "ConfigParameters" : [ ConfigParameter, ... ],
  "CreationDate" : String,
  "Endpoint" : Endpoint,
  "EnhancedVpcRouting" : Boolean,
  "MaxCapacity" : Integer,
  "NamespaceName" : String,
  "PubliclyAccessible" : Boolean,
  "SecurityGroupIds" : [ String, ... ],
  "Status" : String,
  "SubnetIds" : [ String, ... ],
  "WorkgroupArn" : String,
  "WorkgroupId" : String,
  "WorkgroupName" : String
}

YAML

  BaseCapacity: Integer
  ConfigParameters: 
    - ConfigParameter
  CreationDate: String
  Endpoint: 
    Endpoint
  EnhancedVpcRouting: Boolean
  MaxCapacity: Integer
  NamespaceName: String
  PubliclyAccessible: Boolean
  SecurityGroupIds: 
    - String
  Status: String
  SubnetIds: 
    - String
  WorkgroupArn: String
  WorkgroupId: String
  WorkgroupName: String

Properties

BaseCapacity

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

Required: No

Type: Integer

Update requires: No interruption

ConfigParameters

An array of parameters to set for advanced control over a database. 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.

Required: No

Type: Array of ConfigParameter

Update requires: No interruption

CreationDate

The creation date of the workgroup.

Required: No

Type: String

Update requires: No interruption

Endpoint

The endpoint that is created from the workgroup.

Required: No

Type: Endpoint

Update requires: No interruption

EnhancedVpcRouting

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

Required: No

Type: Boolean

Update requires: No interruption

MaxCapacity

The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.

Required: No

Type: Integer

Update requires: No interruption

NamespaceName

The namespace the workgroup is associated with.

Required: No

Type: String

Pattern: ^[a-z0-9-]+$

Minimum: 3

Maximum: 64

Update requires: No interruption

PubliclyAccessible

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

Required: No

Type: Boolean

Update requires: No interruption

SecurityGroupIds

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

Required: No

Type: Array of String

Minimum: 0

Maximum: 255

Update requires: No interruption

Status

The status of the workgroup.

Required: No

Type: String

Allowed values: CREATING | AVAILABLE | MODIFYING | DELETING

Update requires: No interruption

SubnetIds

An array of subnet IDs the workgroup is associated with.

Required: No

Type: Array of String

Minimum: 0

Maximum: 255

Update requires: No interruption

WorkgroupArn

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

Required: No

Type: String

Update requires: No interruption

WorkgroupId

The unique identifier of the workgroup.

Required: No

Type: String

Update requires: No interruption

WorkgroupName

The name of the workgroup.

Required: No

Type: String

Pattern: ^[a-z0-9-]*$

Minimum: 3

Maximum: 64

Update requires: No interruption