AWS::RedshiftServerless::Workgroup - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::RedshiftServerless::Workgroup

The collection of compute resources in Amazon Redshift Serverless.

Syntax

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

JSON

{
  "Type" : "AWS::RedshiftServerless::Workgroup",
  "Properties" : {
      "BaseCapacity" : Integer,
      "ConfigParameters" : [ ConfigParameter, ... ],
      "EnhancedVpcRouting" : Boolean,
      "MaxCapacity" : Integer,
      "NamespaceName" : String,
      "Port" : Integer,
      "PricePerformanceTarget" : PerformanceTarget,
      "PubliclyAccessible" : Boolean,
      "RecoveryPointId" : String,
      "SecurityGroupIds" : [ String, ... ],
      "SnapshotArn" : String,
      "SnapshotName" : String,
      "SnapshotOwnerAccount" : String,
      "SubnetIds" : [ String, ... ],
      "Tags" : [ Tag, ... ],
      "TrackName" : String,
      "Workgroup" : Workgroup,
      "WorkgroupName" : String
    }
}

YAML

Type: AWS::RedshiftServerless::Workgroup
Properties:
  BaseCapacity: Integer
  ConfigParameters: 
    - ConfigParameter
  EnhancedVpcRouting: Boolean
  MaxCapacity: Integer
  NamespaceName: String
  Port: Integer
  PricePerformanceTarget: 
    PerformanceTarget
  PubliclyAccessible: Boolean
  RecoveryPointId: String
  SecurityGroupIds: 
    - String
  SnapshotArn: String
  SnapshotName: String
  SnapshotOwnerAccount: String
  SubnetIds: 
    - String
  Tags: 
    - Tag
  TrackName: String
  Workgroup: 
    Workgroup
  WorkgroupName: String

Properties

BaseCapacity

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

Required: No

Type: Integer

Update requires: No interruption

ConfigParameters

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 .

Required: No

Type: Array of ConfigParameter

Minimum: 1

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-]+$).{3,64}$

Minimum: 3

Maximum: 64

Update requires: Replacement

Port

The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.

Required: No

Type: Integer

Update requires: No interruption

PricePerformanceTarget

An object that represents the price performance target settings for the workgroup.

Required: No

Type: PerformanceTarget

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

RecoveryPointId

The recovery point id to restore from.

Required: No

Type: String

Update requires: No interruption

SecurityGroupIds

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

Required: No

Type: Array of String

Minimum: 0 | 1

Maximum: 255 | 32

Update requires: No interruption

SnapshotArn

The Amazon Resource Name (ARN) of the snapshot to restore from.

Required: No

Type: String

Update requires: No interruption

SnapshotName

The snapshot name to restore from.

Required: No

Type: String

Update requires: No interruption

SnapshotOwnerAccount

The Amazon Web Services account that owns the snapshot.

Required: No

Type: String

Update requires: No interruption

SubnetIds

A list of subnet IDs the workgroup is associated with.

Required: No

Type: Array of String

Minimum: 0 | 1

Maximum: 255 | 32

Update requires: No interruption

Tags

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

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 200

Update requires: No interruption

TrackName

An optional parameter for the name of the track for the workgroup. If you don't provide a track name, the workgroup is assigned to the current track.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9_]+$

Minimum: 1

Maximum: 256

Update requires: No interruption

Workgroup

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

Required: No

Type: Workgroup

Update requires: No interruption

WorkgroupName

The name of the workgroup.

Required: Yes

Type: String

Pattern: ^(?=^[a-z0-9-]+$).{3,64}$

Minimum: 3

Maximum: 64

Update requires: Replacement

Return values

Ref

When the logical ID of this resource is provided to the Ref intrinsic function, Ref returns the WorkgroupName, such as sample-workgroup. For more information about using the Ref function, see Ref.

Fn::GetAtt

GetAtt returns a value for a specified attribute of this type. For more information, see Fn::GetAtt. The following are the available attributes and sample return values.

Workgroup.BaseCapacity

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

Workgroup.CreationDate

The creation date of the workgroup.

Workgroup.Endpoint.Address

The DNS address of the VPC endpoint.

Workgroup.Endpoint.Port

The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.

Workgroup.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.

Workgroup.MaxCapacity

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

Workgroup.NamespaceName

The namespace the workgroup is associated with.

Workgroup.PubliclyAccessible

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

Workgroup.SecurityGroupIds

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

Workgroup.Status

The status of the workgroup.

Workgroup.SubnetIds

An array of subnet IDs the workgroup is associated with.

Workgroup.TrackName

An optional parameter for the name of the track for the workgroup. If you don't provide a track name, the workgroup is assigned to the current track.

Workgroup.WorkgroupArn

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

Workgroup.WorkgroupId

The unique identifier of the workgroup.

Workgroup.WorkgroupName

The name of the workgroup.