AWS v6.55.0 published on Monday, Oct 7, 2024 by Pulumi
aws.redshiftserverless.getWorkgroup
Explore with Pulumi AI
Data source for managing an AWS Redshift Serverless Workgroup.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.redshiftserverless.getWorkgroup({
workgroupName: exampleAwsRedshiftserverlessWorkgroup.workgroupName,
});
import pulumi
import pulumi_aws as aws
example = aws.redshiftserverless.get_workgroup(workgroup_name=example_aws_redshiftserverless_workgroup["workgroupName"])
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/redshiftserverless"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := redshiftserverless.LookupWorkgroup(ctx, &redshiftserverless.LookupWorkgroupArgs{
WorkgroupName: exampleAwsRedshiftserverlessWorkgroup.WorkgroupName,
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = Aws.RedshiftServerless.GetWorkgroup.Invoke(new()
{
WorkgroupName = exampleAwsRedshiftserverlessWorkgroup.WorkgroupName,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.redshiftserverless.RedshiftserverlessFunctions;
import com.pulumi.aws.redshiftserverless.inputs.GetWorkgroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var example = RedshiftserverlessFunctions.getWorkgroup(GetWorkgroupArgs.builder()
.workgroupName(exampleAwsRedshiftserverlessWorkgroup.workgroupName())
.build());
}
}
variables:
example:
fn::invoke:
Function: aws:redshiftserverless:getWorkgroup
Arguments:
workgroupName: ${exampleAwsRedshiftserverlessWorkgroup.workgroupName}
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>
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]
func LookupWorkgroup(ctx *Context, args *LookupWorkgroupArgs, opts ...InvokeOption) (*LookupWorkgroupResult, error)
func LookupWorkgroupOutput(ctx *Context, args *LookupWorkgroupOutputArgs, opts ...InvokeOption) LookupWorkgroupResultOutput
> 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)
}
public static CompletableFuture<GetWorkgroupResult> getWorkgroup(GetWorkgroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws:redshiftserverless/getWorkgroup:getWorkgroup
arguments:
# arguments dictionary
The following arguments are supported:
- Workgroup
Name string - The name of the workgroup associated with the database.
- Workgroup
Name string - The name of the workgroup associated with the database.
- workgroup
Name String - The name of the workgroup associated with the database.
- workgroup
Name string - The name of the workgroup associated with the database.
- workgroup_
name str - The name of the workgroup associated with the database.
- workgroup
Name String - The name of the workgroup associated with the database.
getWorkgroup Result
The following output properties are available:
- Arn string
- Amazon Resource Name (ARN) of the Redshift Serverless Workgroup.
- Endpoints
List<Get
Workgroup Endpoint> - The endpoint that is created from the workgroup. See
Endpoint
below. - Enhanced
Vpc boolRouting - The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC instead of over the internet.
- Id string
- The provider-assigned unique ID for this managed resource.
- Namespace
Name string - Publicly
Accessible bool - A value that specifies whether the workgroup can be accessed from a public network.
- Security
Group List<string>Ids - An array of security group IDs to associate with the workgroup.
- Subnet
Ids List<string> - An array of VPC subnet IDs to associate with the workgroup. When set, must contain at least three subnets spanning three Availability Zones. A minimum number of IP addresses is required and scales with the Base Capacity. For more information, see the following AWS document.
- Workgroup
Id string - The Redshift Workgroup ID.
- Workgroup
Name string
- Arn string
- Amazon Resource Name (ARN) of the Redshift Serverless Workgroup.
- Endpoints
[]Get
Workgroup Endpoint - The endpoint that is created from the workgroup. See
Endpoint
below. - Enhanced
Vpc boolRouting - The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC instead of over the internet.
- Id string
- The provider-assigned unique ID for this managed resource.
- Namespace
Name string - Publicly
Accessible bool - A value that specifies whether the workgroup can be accessed from a public network.
- Security
Group []stringIds - An array of security group IDs to associate with the workgroup.
- Subnet
Ids []string - An array of VPC subnet IDs to associate with the workgroup. When set, must contain at least three subnets spanning three Availability Zones. A minimum number of IP addresses is required and scales with the Base Capacity. For more information, see the following AWS document.
- Workgroup
Id string - The Redshift Workgroup ID.
- Workgroup
Name string
- arn String
- Amazon Resource Name (ARN) of the Redshift Serverless Workgroup.
- endpoints
List<Get
Workgroup Endpoint> - The endpoint that is created from the workgroup. See
Endpoint
below. - enhanced
Vpc BooleanRouting - The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC instead of over the internet.
- id String
- The provider-assigned unique ID for this managed resource.
- namespace
Name String - publicly
Accessible Boolean - A value that specifies whether the workgroup can be accessed from a public network.
- security
Group List<String>Ids - An array of security group IDs to associate with the workgroup.
- subnet
Ids List<String> - An array of VPC subnet IDs to associate with the workgroup. When set, must contain at least three subnets spanning three Availability Zones. A minimum number of IP addresses is required and scales with the Base Capacity. For more information, see the following AWS document.
- workgroup
Id String - The Redshift Workgroup ID.
- workgroup
Name String
- arn string
- Amazon Resource Name (ARN) of the Redshift Serverless Workgroup.
- endpoints
Get
Workgroup Endpoint[] - The endpoint that is created from the workgroup. See
Endpoint
below. - enhanced
Vpc booleanRouting - The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC instead of over the internet.
- id string
- The provider-assigned unique ID for this managed resource.
- namespace
Name string - publicly
Accessible boolean - A value that specifies whether the workgroup can be accessed from a public network.
- security
Group string[]Ids - An array of security group IDs to associate with the workgroup.
- subnet
Ids string[] - An array of VPC subnet IDs to associate with the workgroup. When set, must contain at least three subnets spanning three Availability Zones. A minimum number of IP addresses is required and scales with the Base Capacity. For more information, see the following AWS document.
- workgroup
Id string - The Redshift Workgroup ID.
- workgroup
Name string
- arn str
- Amazon Resource Name (ARN) of the Redshift Serverless Workgroup.
- endpoints
Sequence[Get
Workgroup Endpoint] - The endpoint that is created from the workgroup. See
Endpoint
below. - enhanced_
vpc_ boolrouting - The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC instead of over the internet.
- id str
- The provider-assigned unique ID for this managed resource.
- namespace_
name str - publicly_
accessible bool - A value that specifies whether the workgroup can be accessed from a public network.
- security_
group_ Sequence[str]ids - An array of security group IDs to associate with the workgroup.
- subnet_
ids Sequence[str] - An array of VPC subnet IDs to associate with the workgroup. When set, must contain at least three subnets spanning three Availability Zones. A minimum number of IP addresses is required and scales with the Base Capacity. For more information, see the following AWS document.
- workgroup_
id str - The Redshift Workgroup ID.
- workgroup_
name str
- arn String
- Amazon Resource Name (ARN) of the Redshift Serverless Workgroup.
- endpoints List<Property Map>
- The endpoint that is created from the workgroup. See
Endpoint
below. - enhanced
Vpc BooleanRouting - The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC instead of over the internet.
- id String
- The provider-assigned unique ID for this managed resource.
- namespace
Name String - publicly
Accessible Boolean - A value that specifies whether the workgroup can be accessed from a public network.
- security
Group List<String>Ids - An array of security group IDs to associate with the workgroup.
- subnet
Ids List<String> - An array of VPC subnet IDs to associate with the workgroup. When set, must contain at least three subnets spanning three Availability Zones. A minimum number of IP addresses is required and scales with the Base Capacity. For more information, see the following AWS document.
- workgroup
Id String - The Redshift Workgroup ID.
- workgroup
Name String
Supporting Types
GetWorkgroupEndpoint
- Address string
- The DNS address of the VPC endpoint.
- Port int
- The port that Amazon Redshift Serverless listens on.
- Vpc
Endpoints List<GetWorkgroup Endpoint Vpc Endpoint> - The VPC endpoint or the Redshift Serverless workgroup. See
VPC Endpoint
below.
- Address string
- The DNS address of the VPC endpoint.
- Port int
- The port that Amazon Redshift Serverless listens on.
- Vpc
Endpoints []GetWorkgroup Endpoint Vpc Endpoint - The VPC endpoint or the Redshift Serverless workgroup. See
VPC Endpoint
below.
- address String
- The DNS address of the VPC endpoint.
- port Integer
- The port that Amazon Redshift Serverless listens on.
- vpc
Endpoints List<GetWorkgroup Endpoint Vpc Endpoint> - The VPC endpoint or the Redshift Serverless workgroup. See
VPC Endpoint
below.
- address string
- The DNS address of the VPC endpoint.
- port number
- The port that Amazon Redshift Serverless listens on.
- vpc
Endpoints GetWorkgroup Endpoint Vpc Endpoint[] - The VPC endpoint or the Redshift Serverless workgroup. See
VPC Endpoint
below.
- address str
- The DNS address of the VPC endpoint.
- port int
- The port that Amazon Redshift Serverless listens on.
- vpc_
endpoints Sequence[GetWorkgroup Endpoint Vpc Endpoint] - The VPC endpoint or the Redshift Serverless workgroup. See
VPC Endpoint
below.
- address String
- The DNS address of the VPC endpoint.
- port Number
- The port that Amazon Redshift Serverless listens on.
- vpc
Endpoints List<Property Map> - The VPC endpoint or the Redshift Serverless workgroup. See
VPC Endpoint
below.
GetWorkgroupEndpointVpcEndpoint
- Network
Interfaces List<GetWorkgroup Endpoint Vpc Endpoint Network Interface> - The network interfaces of the endpoint.. See
Network Interface
below. - Vpc
Endpoint stringId - The DNS address of the VPC endpoint.
- Vpc
Id string - The port that Amazon Redshift Serverless listens on.
- Network
Interfaces []GetWorkgroup Endpoint Vpc Endpoint Network Interface - The network interfaces of the endpoint.. See
Network Interface
below. - Vpc
Endpoint stringId - The DNS address of the VPC endpoint.
- Vpc
Id string - The port that Amazon Redshift Serverless listens on.
- network
Interfaces List<GetWorkgroup Endpoint Vpc Endpoint Network Interface> - The network interfaces of the endpoint.. See
Network Interface
below. - vpc
Endpoint StringId - The DNS address of the VPC endpoint.
- vpc
Id String - The port that Amazon Redshift Serverless listens on.
- network
Interfaces GetWorkgroup Endpoint Vpc Endpoint Network Interface[] - The network interfaces of the endpoint.. See
Network Interface
below. - vpc
Endpoint stringId - The DNS address of the VPC endpoint.
- vpc
Id string - The port that Amazon Redshift Serverless listens on.
- network_
interfaces Sequence[GetWorkgroup Endpoint Vpc Endpoint Network Interface] - The network interfaces of the endpoint.. See
Network Interface
below. - vpc_
endpoint_ strid - The DNS address of the VPC endpoint.
- vpc_
id str - The port that Amazon Redshift Serverless listens on.
- network
Interfaces List<Property Map> - The network interfaces of the endpoint.. See
Network Interface
below. - vpc
Endpoint StringId - The DNS address of the VPC endpoint.
- vpc
Id String - The port that Amazon Redshift Serverless listens on.
GetWorkgroupEndpointVpcEndpointNetworkInterface
- Availability
Zone string - The availability Zone.
- Network
Interface stringId - The unique identifier of the network interface.
- Private
Ip stringAddress - The IPv4 address of the network interface within the subnet.
- Subnet
Id string - The unique identifier of the subnet.
- Availability
Zone string - The availability Zone.
- Network
Interface stringId - The unique identifier of the network interface.
- Private
Ip stringAddress - The IPv4 address of the network interface within the subnet.
- Subnet
Id string - The unique identifier of the subnet.
- availability
Zone String - The availability Zone.
- network
Interface StringId - The unique identifier of the network interface.
- private
Ip StringAddress - The IPv4 address of the network interface within the subnet.
- subnet
Id String - The unique identifier of the subnet.
- availability
Zone string - The availability Zone.
- network
Interface stringId - The unique identifier of the network interface.
- private
Ip stringAddress - The IPv4 address of the network interface within the subnet.
- subnet
Id string - The unique identifier of the subnet.
- availability_
zone str - The availability Zone.
- network_
interface_ strid - The unique identifier of the network interface.
- private_
ip_ straddress - The IPv4 address of the network interface within the subnet.
- subnet_
id str - The unique identifier of the subnet.
- availability
Zone String - The availability Zone.
- network
Interface StringId - The unique identifier of the network interface.
- private
Ip StringAddress - The IPv4 address of the network interface within the subnet.
- subnet
Id String - The unique identifier of the subnet.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.