1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. redshiftserverless
  5. getWorkgroup

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

aws-native.redshiftserverless.getWorkgroup

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

Definition of AWS::RedshiftServerless::Workgroup Resource Type

Using getWorkgroup

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getWorkgroup(args: GetWorkgroupArgs, opts?: InvokeOptions): Promise<GetWorkgroupResult>
function getWorkgroupOutput(args: GetWorkgroupOutputArgs, opts?: InvokeOptions): Output<GetWorkgroupResult>
Copy
def get_workgroup(workgroup_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetWorkgroupResult
def get_workgroup_output(workgroup_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetWorkgroupResult]
Copy
func LookupWorkgroup(ctx *Context, args *LookupWorkgroupArgs, opts ...InvokeOption) (*LookupWorkgroupResult, error)
func LookupWorkgroupOutput(ctx *Context, args *LookupWorkgroupOutputArgs, opts ...InvokeOption) LookupWorkgroupResultOutput
Copy

> Note: This function is named LookupWorkgroup in the Go SDK.

public static class GetWorkgroup 
{
    public static Task<GetWorkgroupResult> InvokeAsync(GetWorkgroupArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkgroupResult> Invoke(GetWorkgroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetWorkgroupResult> getWorkgroup(GetWorkgroupArgs args, InvokeOptions options)
public static Output<GetWorkgroupResult> getWorkgroup(GetWorkgroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:redshiftserverless:getWorkgroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

WorkgroupName This property is required. string
The name of the workgroup.
WorkgroupName This property is required. string
The name of the workgroup.
workgroupName This property is required. String
The name of the workgroup.
workgroupName This property is required. string
The name of the workgroup.
workgroup_name This property is required. str
The name of the workgroup.
workgroupName This property is required. String
The name of the workgroup.

getWorkgroup Result

The following output properties are available:

EnhancedVpcRouting bool
The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
Port int
The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
PricePerformanceTarget Pulumi.AwsNative.RedshiftServerless.Outputs.WorkgroupPerformanceTarget
A property that represents the price performance target settings for the workgroup.
PubliclyAccessible bool
A value that specifies whether the workgroup can be accessible from a public network.
Tags List<Pulumi.AwsNative.Outputs.Tag>
The map of the key-value pairs used to tag the workgroup.
WorkgroupValue Pulumi.AwsNative.RedshiftServerless.Outputs.Workgroup
Definition for workgroup resource
EnhancedVpcRouting bool
The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
Port int
The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
PricePerformanceTarget WorkgroupPerformanceTarget
A property that represents the price performance target settings for the workgroup.
PubliclyAccessible bool
A value that specifies whether the workgroup can be accessible from a public network.
Tags Tag
The map of the key-value pairs used to tag the workgroup.
Workgroup WorkgroupType
Definition for workgroup resource
enhancedVpcRouting 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.
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.
pricePerformanceTarget WorkgroupPerformanceTarget
A property that represents the price performance target settings for the workgroup.
publiclyAccessible Boolean
A value that specifies whether the workgroup can be accessible from a public network.
tags List<Tag>
The map of the key-value pairs used to tag the workgroup.
workgroup Workgroup
Definition for workgroup resource
enhancedVpcRouting 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.
port number
The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
pricePerformanceTarget WorkgroupPerformanceTarget
A property that represents the price performance target settings for the workgroup.
publiclyAccessible boolean
A value that specifies whether the workgroup can be accessible from a public network.
tags Tag[]
The map of the key-value pairs used to tag the workgroup.
workgroup Workgroup
Definition for workgroup resource
enhanced_vpc_routing bool
The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
port int
The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
price_performance_target WorkgroupPerformanceTarget
A property that represents the price performance target settings for the workgroup.
publicly_accessible bool
A value that specifies whether the workgroup can be accessible from a public network.
tags Sequence[root_Tag]
The map of the key-value pairs used to tag the workgroup.
workgroup Workgroup
Definition for workgroup resource
enhancedVpcRouting 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.
port Number
The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
pricePerformanceTarget Property Map
A property that represents the price performance target settings for the workgroup.
publiclyAccessible Boolean
A value that specifies whether the workgroup can be accessible from a public network.
tags List<Property Map>
The map of the key-value pairs used to tag the workgroup.
workgroup Property Map
Definition for workgroup resource

Supporting Types

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Workgroup

BaseCapacity int
The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
ConfigParameters List<Pulumi.AwsNative.RedshiftServerless.Inputs.WorkgroupConfigParameter>
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 .
CreationDate string
The creation date of the workgroup.
Endpoint Pulumi.AwsNative.RedshiftServerless.Inputs.WorkgroupEndpoint
The endpoint that is created from the workgroup.
EnhancedVpcRouting bool
The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
MaxCapacity int
The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.
NamespaceName string
The namespace the workgroup is associated with.
PricePerformanceTarget Pulumi.AwsNative.RedshiftServerless.Inputs.WorkgroupPerformanceTarget
An object that represents the price performance target settings for the workgroup.
PubliclyAccessible bool
A value that specifies whether the workgroup can be accessible from a public network.
SecurityGroupIds List<string>
An array of security group IDs to associate with the workgroup.
Status Pulumi.AwsNative.RedshiftServerless.WorkgroupStatus
The status of the workgroup.
SubnetIds List<string>
An array of subnet IDs the workgroup is associated with.
WorkgroupArn string
The Amazon Resource Name (ARN) that links to the workgroup.
WorkgroupId string
The unique identifier of the workgroup.
WorkgroupName string
The name of the workgroup.
BaseCapacity int
The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
ConfigParameters []WorkgroupConfigParameter
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 .
CreationDate string
The creation date of the workgroup.
Endpoint WorkgroupEndpoint
The endpoint that is created from the workgroup.
EnhancedVpcRouting bool
The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
MaxCapacity int
The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.
NamespaceName string
The namespace the workgroup is associated with.
PricePerformanceTarget WorkgroupPerformanceTarget
An object that represents the price performance target settings for the workgroup.
PubliclyAccessible bool
A 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 WorkgroupStatus
The status of the workgroup.
SubnetIds []string
An array of subnet IDs the workgroup is associated with.
WorkgroupArn string
The Amazon Resource Name (ARN) that links to the workgroup.
WorkgroupId string
The unique identifier of the workgroup.
WorkgroupName string
The name of the workgroup.
baseCapacity Integer
The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
configParameters List<WorkgroupConfigParameter>
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 .
creationDate String
The creation date of the workgroup.
endpoint WorkgroupEndpoint
The endpoint that is created from the workgroup.
enhancedVpcRouting 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.
maxCapacity Integer
The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.
namespaceName String
The namespace the workgroup is associated with.
pricePerformanceTarget WorkgroupPerformanceTarget
An object that represents the price performance target settings for the workgroup.
publiclyAccessible Boolean
A value that specifies whether the workgroup can be accessible from a public network.
securityGroupIds List<String>
An array of security group IDs to associate with the workgroup.
status WorkgroupStatus
The status of the workgroup.
subnetIds List<String>
An array of subnet IDs the workgroup is associated with.
workgroupArn String
The Amazon Resource Name (ARN) that links to the workgroup.
workgroupId String
The unique identifier of the workgroup.
workgroupName String
The name of the workgroup.
baseCapacity number
The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
configParameters WorkgroupConfigParameter[]
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 .
creationDate string
The creation date of the workgroup.
endpoint WorkgroupEndpoint
The endpoint that is created from the workgroup.
enhancedVpcRouting 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.
maxCapacity number
The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.
namespaceName string
The namespace the workgroup is associated with.
pricePerformanceTarget WorkgroupPerformanceTarget
An object that represents the price performance target settings for the workgroup.
publiclyAccessible boolean
A 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 WorkgroupStatus
The status of the workgroup.
subnetIds string[]
An array of subnet IDs the workgroup is associated with.
workgroupArn string
The Amazon Resource Name (ARN) that links to the workgroup.
workgroupId string
The unique identifier of the workgroup.
workgroupName string
The name of the workgroup.
base_capacity int
The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
config_parameters Sequence[WorkgroupConfigParameter]
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 .
creation_date str
The creation date of the workgroup.
endpoint WorkgroupEndpoint
The endpoint that is created from the workgroup.
enhanced_vpc_routing bool
The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
max_capacity int
The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.
namespace_name str
The namespace the workgroup is associated with.
price_performance_target WorkgroupPerformanceTarget
An object that represents the price performance target settings for the workgroup.
publicly_accessible bool
A value that specifies whether the workgroup can be accessible from a public network.
security_group_ids Sequence[str]
An array of security group IDs to associate with the workgroup.
status WorkgroupStatus
The status of the workgroup.
subnet_ids Sequence[str]
An array of subnet IDs the workgroup is associated with.
workgroup_arn str
The Amazon Resource Name (ARN) that links to the workgroup.
workgroup_id str
The unique identifier of the workgroup.
workgroup_name str
The name of the workgroup.
baseCapacity Number
The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
configParameters List<Property Map>
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 .
creationDate String
The creation date of the workgroup.
endpoint Property Map
The endpoint that is created from the workgroup.
enhancedVpcRouting 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.
maxCapacity Number
The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.
namespaceName String
The namespace the workgroup is associated with.
pricePerformanceTarget Property Map
An object that represents the price performance target settings for the workgroup.
publiclyAccessible Boolean
A value that specifies whether the workgroup can be accessible from a public network.
securityGroupIds List<String>
An array of security group IDs to associate with the workgroup.
status "CREATING" | "AVAILABLE" | "MODIFYING" | "DELETING"
The status of the workgroup.
subnetIds List<String>
An array of subnet IDs the workgroup is associated with.
workgroupArn String
The Amazon Resource Name (ARN) that links to the workgroup.
workgroupId String
The unique identifier of the workgroup.
workgroupName String
The name of the workgroup.

WorkgroupConfigParameter

ParameterKey string
The key of the parameter. The options are datestyle , enable_user_activity_logging , query_group , search_path , max_query_execution_time , and require_ssl .
ParameterValue string
The value of the parameter to set.
ParameterKey string
The key of the parameter. The options are datestyle , enable_user_activity_logging , query_group , search_path , max_query_execution_time , and require_ssl .
ParameterValue string
The value of the parameter to set.
parameterKey String
The key of the parameter. The options are datestyle , enable_user_activity_logging , query_group , search_path , max_query_execution_time , and require_ssl .
parameterValue String
The value of the parameter to set.
parameterKey string
The key of the parameter. The options are datestyle , enable_user_activity_logging , query_group , search_path , max_query_execution_time , and require_ssl .
parameterValue string
The value of the parameter to set.
parameter_key str
The key of the parameter. The options are datestyle , enable_user_activity_logging , query_group , search_path , max_query_execution_time , and require_ssl .
parameter_value str
The value of the parameter to set.
parameterKey String
The key of the parameter. The options are datestyle , enable_user_activity_logging , query_group , search_path , max_query_execution_time , and require_ssl .
parameterValue String
The value of the parameter to set.

WorkgroupEndpoint

Address string
The DNS address of the VPC endpoint.
Port int
The port that Amazon Redshift Serverless listens on.
VpcEndpoints List<Pulumi.AwsNative.RedshiftServerless.Inputs.WorkgroupVpcEndpoint>
An array of VpcEndpoint objects.
Address string
The DNS address of the VPC endpoint.
Port int
The port that Amazon Redshift Serverless listens on.
VpcEndpoints []WorkgroupVpcEndpoint
An array of VpcEndpoint objects.
address String
The DNS address of the VPC endpoint.
port Integer
The port that Amazon Redshift Serverless listens on.
vpcEndpoints List<WorkgroupVpcEndpoint>
An array of VpcEndpoint objects.
address string
The DNS address of the VPC endpoint.
port number
The port that Amazon Redshift Serverless listens on.
vpcEndpoints WorkgroupVpcEndpoint[]
An array of VpcEndpoint objects.
address str
The DNS address of the VPC endpoint.
port int
The port that Amazon Redshift Serverless listens on.
vpc_endpoints Sequence[WorkgroupVpcEndpoint]
An array of VpcEndpoint objects.
address String
The DNS address of the VPC endpoint.
port Number
The port that Amazon Redshift Serverless listens on.
vpcEndpoints List<Property Map>
An array of VpcEndpoint objects.

WorkgroupNetworkInterface

AvailabilityZone string
The availability Zone.
NetworkInterfaceId string
The unique identifier of the network interface.
PrivateIpAddress string
The IPv4 address of the network interface within the subnet.
SubnetId string
The unique identifier of the subnet.
AvailabilityZone string
The availability Zone.
NetworkInterfaceId string
The unique identifier of the network interface.
PrivateIpAddress string
The IPv4 address of the network interface within the subnet.
SubnetId string
The unique identifier of the subnet.
availabilityZone String
The availability Zone.
networkInterfaceId String
The unique identifier of the network interface.
privateIpAddress String
The IPv4 address of the network interface within the subnet.
subnetId String
The unique identifier of the subnet.
availabilityZone string
The availability Zone.
networkInterfaceId string
The unique identifier of the network interface.
privateIpAddress string
The IPv4 address of the network interface within the subnet.
subnetId string
The unique identifier of the subnet.
availability_zone str
The availability Zone.
network_interface_id str
The unique identifier of the network interface.
private_ip_address str
The IPv4 address of the network interface within the subnet.
subnet_id str
The unique identifier of the subnet.
availabilityZone String
The availability Zone.
networkInterfaceId String
The unique identifier of the network interface.
privateIpAddress String
The IPv4 address of the network interface within the subnet.
subnetId String
The unique identifier of the subnet.

WorkgroupPerformanceTarget

Level int
The target price performance level for the workgroup. Valid values include 1, 25, 50, 75, and 100. These correspond to the price performance levels LOW_COST, ECONOMICAL, BALANCED, RESOURCEFUL, and HIGH_PERFORMANCE.
Status Pulumi.AwsNative.RedshiftServerless.WorkgroupPerformanceTargetStatus
Whether the price performance target is enabled for the workgroup.
Level int
The target price performance level for the workgroup. Valid values include 1, 25, 50, 75, and 100. These correspond to the price performance levels LOW_COST, ECONOMICAL, BALANCED, RESOURCEFUL, and HIGH_PERFORMANCE.
Status WorkgroupPerformanceTargetStatus
Whether the price performance target is enabled for the workgroup.
level Integer
The target price performance level for the workgroup. Valid values include 1, 25, 50, 75, and 100. These correspond to the price performance levels LOW_COST, ECONOMICAL, BALANCED, RESOURCEFUL, and HIGH_PERFORMANCE.
status WorkgroupPerformanceTargetStatus
Whether the price performance target is enabled for the workgroup.
level number
The target price performance level for the workgroup. Valid values include 1, 25, 50, 75, and 100. These correspond to the price performance levels LOW_COST, ECONOMICAL, BALANCED, RESOURCEFUL, and HIGH_PERFORMANCE.
status WorkgroupPerformanceTargetStatus
Whether the price performance target is enabled for the workgroup.
level int
The target price performance level for the workgroup. Valid values include 1, 25, 50, 75, and 100. These correspond to the price performance levels LOW_COST, ECONOMICAL, BALANCED, RESOURCEFUL, and HIGH_PERFORMANCE.
status WorkgroupPerformanceTargetStatus
Whether the price performance target is enabled for the workgroup.
level Number
The target price performance level for the workgroup. Valid values include 1, 25, 50, 75, and 100. These correspond to the price performance levels LOW_COST, ECONOMICAL, BALANCED, RESOURCEFUL, and HIGH_PERFORMANCE.
status "ENABLED" | "DISABLED"
Whether the price performance target is enabled for the workgroup.

WorkgroupPerformanceTargetStatus

WorkgroupStatus

WorkgroupVpcEndpoint

NetworkInterfaces List<Pulumi.AwsNative.RedshiftServerless.Inputs.WorkgroupNetworkInterface>
One or more network interfaces of the endpoint. Also known as an interface endpoint.
VpcEndpointId string
The connection endpoint ID for connecting to Amazon Redshift Serverless.
VpcId string
The VPC identifier that the endpoint is associated with.
NetworkInterfaces []WorkgroupNetworkInterface
One or more network interfaces of the endpoint. Also known as an interface endpoint.
VpcEndpointId string
The connection endpoint ID for connecting to Amazon Redshift Serverless.
VpcId string
The VPC identifier that the endpoint is associated with.
networkInterfaces List<WorkgroupNetworkInterface>
One or more network interfaces of the endpoint. Also known as an interface endpoint.
vpcEndpointId String
The connection endpoint ID for connecting to Amazon Redshift Serverless.
vpcId String
The VPC identifier that the endpoint is associated with.
networkInterfaces WorkgroupNetworkInterface[]
One or more network interfaces of the endpoint. Also known as an interface endpoint.
vpcEndpointId string
The connection endpoint ID for connecting to Amazon Redshift Serverless.
vpcId string
The VPC identifier that the endpoint is associated with.
network_interfaces Sequence[WorkgroupNetworkInterface]
One or more network interfaces of the endpoint. Also known as an interface endpoint.
vpc_endpoint_id str
The connection endpoint ID for connecting to Amazon Redshift Serverless.
vpc_id str
The VPC identifier that the endpoint is associated with.
networkInterfaces List<Property Map>
One or more network interfaces of the endpoint. Also known as an interface endpoint.
vpcEndpointId String
The connection endpoint ID for connecting to Amazon Redshift Serverless.
vpcId String
The VPC identifier that the endpoint is associated with.

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi