AWS::RedshiftServerless::Workgroup - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::RedshiftServerless::Workgroup

The collection of compute resources in Amazon Redshift Serverless.

Syntax

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

JSON

{
  "Type" : "AWS::RedshiftServerless::Workgroup",
  "Properties" : {
      "BaseCapacity" : Integer,
      "ConfigParameters" : [ ConfigParameter, ... ],
      "EnhancedVpcRouting" : Boolean,
      "NamespaceName" : String,
      "Port" : Integer,
      "PubliclyAccessible" : Boolean,
      "SecurityGroupIds" : [ String, ... ],
      "SubnetIds" : [ String, ... ],
      "Tags" : [ Tag, ... ],
      "WorkgroupName" : String
    }
}

YAML

Type: AWS::RedshiftServerless::Workgroup
Properties: 
  BaseCapacity: Integer
  ConfigParameters: 
    - ConfigParameter
  EnhancedVpcRouting: Boolean
  NamespaceName: String
  Port: Integer
  PubliclyAccessible: Boolean
  SecurityGroupIds: 
    - String
  SubnetIds: 
    - String
  Tags: 
    - Tag
  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

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.

Required: No

Type: List of ConfigParameter

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

NamespaceName

The namespace the workgroup is associated with.

Required: No

Type: String

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

PubliclyAccessible

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

Required: No

Type: Boolean

Update requires: No interruption

SecurityGroupIds

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

Required: No

Type: List of String

Update requires: No interruption

SubnetIds

A list of subnet IDs the workgroup is associated with.

Required: No

Type: List of String

Update requires: No interruption

Tags

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

Required: No

Type: List of Tag

Update requires: No interruption

WorkgroupName

The name of the workgroup.

Required: Yes

Type: String

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

Returns the Workgroup value.

Workgroup.BaseCapacity

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

Workgroup.ConfigParameters

Property description not available.

Workgroup.CreationDate

The creation date of the workgroup.

Workgroup.Endpoint

Property description not available.

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.Endpoint.VpcEndpoints

Property description not available.

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