workgroup
Gets an individual workgroup
resource
Overview
Name | workgroup |
Type | Resource |
Description | workgroup |
Id | awscc.redshiftserverless.workgroup |
Fields
Name | Datatype | Description |
---|---|---|
workgroup_name | string | The name of the workgroup. |
namespace_name | string | The namespace the workgroup is associated with. |
base_capacity | integer | The base compute capacity of the workgroup in Redshift Processing Units (RPUs). |
max_capacity | integer | The max compute capacity of the workgroup in Redshift Processing Units (RPUs). |
enhanced_vpc_routing | boolean | The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC. |
config_parameters | array | A list of parameters to set for finer control over a database. Available options are datestyle, enable_user_activity_logging, query_group, search_path, max_query_execution_time, and require_ssl. |
security_group_ids | array | A list of security group IDs to associate with the workgroup. |
subnet_ids | array | A list of subnet IDs the workgroup is associated with. |
publicly_accessible | boolean | A value that specifies whether the workgroup can be accessible from a public network. |
port | integer | The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439. |
tags | array | The map of the key-value pairs used to tag the workgroup. |
workgroup | object | Definition for workgroup resource |
region | string | AWS region. |
Methods
Currently only SELECT
is supported for this resource resource.
Example
SELECT
region,
workgroup_name,
namespace_name,
base_capacity,
max_capacity,
enhanced_vpc_routing,
config_parameters,
security_group_ids,
subnet_ids,
publicly_accessible,
port,
tags,
workgroup
FROM awscc.redshiftserverless.workgroup
WHERE data__Identifier = '<WorkgroupName>';
Permissions
To operate on the workgroup
resource, the following permissions are required:
Read
ec2:DescribeVpcAttribute,
ec2:DescribeSecurityGroups,
ec2:DescribeAddresses,
ec2:DescribeInternetGateways,
ec2:DescribeSubnets,
ec2:DescribeAccountAttributes,
ec2:DescribeAvailabilityZones,
redshift-serverless:GetWorkgroup
Update
ec2:DescribeVpcAttribute,
ec2:DescribeSecurityGroups,
ec2:DescribeAddresses,
ec2:DescribeInternetGateways,
ec2:DescribeSubnets,
ec2:DescribeAccountAttributes,
ec2:DescribeAvailabilityZones,
redshift-serverless:ListTagsForResource,
redshift-serverless:TagResource,
redshift-serverless:UntagResource,
redshift-serverless:GetWorkgroup,
redshift-serverless:UpdateWorkgroup
Delete
ec2:DescribeVpcAttribute,
ec2:DescribeSecurityGroups,
ec2:DescribeAddresses,
ec2:DescribeInternetGateways,
ec2:DescribeSubnets,
ec2:DescribeAccountAttributes,
ec2:DescribeAvailabilityZones,
redshift-serverless:GetWorkgroup,
redshift-serverless:DeleteWorkgroup