Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. redshiftserverless
  5. Workgroup
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.redshiftserverless.Workgroup

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Creates a new Amazon Redshift Serverless Workgroup.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.redshiftserverless.Workgroup("example", {
    namespaceName: "concurrency-scaling",
    workgroupName: "concurrency-scaling",
});

    import pulumi
import pulumi_aws as aws

example = aws.redshiftserverless.Workgroup("example",
    namespace_name="concurrency-scaling",
    workgroup_name="concurrency-scaling")

    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.NewWorkgroup(ctx, "example", &redshiftserverless.WorkgroupArgs{
			NamespaceName: pulumi.String("concurrency-scaling"),
			WorkgroupName: pulumi.String("concurrency-scaling"),
		})
		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 = new Aws.RedshiftServerless.Workgroup("example", new()
    {
        NamespaceName = "concurrency-scaling",
        WorkgroupName = "concurrency-scaling",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.redshiftserverless.Workgroup;
import com.pulumi.aws.redshiftserverless.WorkgroupArgs;
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) {
        var example = new Workgroup("example", WorkgroupArgs.builder()
            .namespaceName("concurrency-scaling")
            .workgroupName("concurrency-scaling")
            .build());

    }
}

    resources:
  example:
    type: aws:redshiftserverless:Workgroup
    properties:
      namespaceName: concurrency-scaling
      workgroupName: concurrency-scaling

    Create Workgroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Workgroup(name: string, args: WorkgroupArgs, opts?: CustomResourceOptions);
    @overload
def Workgroup(resource_name: str,
              args: WorkgroupArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def Workgroup(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              namespace_name: Optional[str] = None,
              workgroup_name: Optional[str] = None,
              base_capacity: Optional[int] = None,
              config_parameters: Optional[Sequence[WorkgroupConfigParameterArgs]] = None,
              enhanced_vpc_routing: Optional[bool] = None,
              max_capacity: Optional[int] = None,
              port: Optional[int] = None,
              publicly_accessible: Optional[bool] = None,
              security_group_ids: Optional[Sequence[str]] = None,
              subnet_ids: Optional[Sequence[str]] = None,
              tags: Optional[Mapping[str, str]] = None)
    func NewWorkgroup(ctx *Context, name string, args WorkgroupArgs, opts ...ResourceOption) (*Workgroup, error)
    public Workgroup(string name, WorkgroupArgs args, CustomResourceOptions? opts = null)
    public Workgroup(String name, WorkgroupArgs args)
public Workgroup(String name, WorkgroupArgs args, CustomResourceOptions options)

    type: aws:redshiftserverless:Workgroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args WorkgroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args WorkgroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args WorkgroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkgroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkgroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var awsWorkgroupResource = new Aws.RedshiftServerless.Workgroup("awsWorkgroupResource", new()
{
    NamespaceName = "string",
    WorkgroupName = "string",
    BaseCapacity = 0,
    ConfigParameters = new[]
    {
        new Aws.RedshiftServerless.Inputs.WorkgroupConfigParameterArgs
        {
            ParameterKey = "string",
            ParameterValue = "string",
        },
    },
    EnhancedVpcRouting = false,
    MaxCapacity = 0,
    Port = 0,
    PubliclyAccessible = false,
    SecurityGroupIds = new[]
    {
        "string",
    },
    SubnetIds = new[]
    {
        "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := redshiftserverless.NewWorkgroup(ctx, "awsWorkgroupResource", &redshiftserverless.WorkgroupArgs{
	NamespaceName: pulumi.String("string"),
	WorkgroupName: pulumi.String("string"),
	BaseCapacity:  pulumi.Int(0),
	ConfigParameters: redshiftserverless.WorkgroupConfigParameterArray{
		&redshiftserverless.WorkgroupConfigParameterArgs{
			ParameterKey:   pulumi.String("string"),
			ParameterValue: pulumi.String("string"),
		},
	},
	EnhancedVpcRouting: pulumi.Bool(false),
	MaxCapacity:        pulumi.Int(0),
	Port:               pulumi.Int(0),
	PubliclyAccessible: pulumi.Bool(false),
	SecurityGroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	SubnetIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var awsWorkgroupResource = new Workgroup("awsWorkgroupResource", WorkgroupArgs.builder()
    .namespaceName("string")
    .workgroupName("string")
    .baseCapacity(0)
    .configParameters(WorkgroupConfigParameterArgs.builder()
        .parameterKey("string")
        .parameterValue("string")
        .build())
    .enhancedVpcRouting(false)
    .maxCapacity(0)
    .port(0)
    .publiclyAccessible(false)
    .securityGroupIds("string")
    .subnetIds("string")
    .tags(Map.of("string", "string"))
    .build());

    aws_workgroup_resource = aws.redshiftserverless.Workgroup("awsWorkgroupResource",
    namespace_name="string",
    workgroup_name="string",
    base_capacity=0,
    config_parameters=[{
        "parameter_key": "string",
        "parameter_value": "string",
    }],
    enhanced_vpc_routing=False,
    max_capacity=0,
    port=0,
    publicly_accessible=False,
    security_group_ids=["string"],
    subnet_ids=["string"],
    tags={
        "string": "string",
    })

    const awsWorkgroupResource = new aws.redshiftserverless.Workgroup("awsWorkgroupResource", {
    namespaceName: "string",
    workgroupName: "string",
    baseCapacity: 0,
    configParameters: [{
        parameterKey: "string",
        parameterValue: "string",
    }],
    enhancedVpcRouting: false,
    maxCapacity: 0,
    port: 0,
    publiclyAccessible: false,
    securityGroupIds: ["string"],
    subnetIds: ["string"],
    tags: {
        string: "string",
    },
});

    type: aws:redshiftserverless:Workgroup
properties:
    baseCapacity: 0
    configParameters:
        - parameterKey: string
          parameterValue: string
    enhancedVpcRouting: false
    maxCapacity: 0
    namespaceName: string
    port: 0
    publiclyAccessible: false
    securityGroupIds:
        - string
    subnetIds:
        - string
    tags:
        string: string
    workgroupName: string

    Workgroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Workgroup resource accepts the following input properties:

    NamespaceName string
    The name of the namespace.
    WorkgroupName string

    The name of the workgroup.

    The following arguments are optional:

    BaseCapacity int
    The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
    ConfigParameters List<WorkgroupConfigParameter>
    An array of parameters to set for more control over a serverless database. See Config Parameter below.
    EnhancedVpcRouting bool
    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.
    MaxCapacity int
    The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries, specified in Redshift Processing Units (RPUs).
    Port int
    The port number on which the cluster accepts incoming connections.
    PubliclyAccessible bool
    A value that specifies whether the workgroup can be accessed from a public network.
    SecurityGroupIds List<string>
    An array of security group IDs to associate with the workgroup.
    SubnetIds 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.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    NamespaceName string
    The name of the namespace.
    WorkgroupName string

    The name of the workgroup.

    The following arguments are optional:

    BaseCapacity int
    The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
    ConfigParameters []WorkgroupConfigParameterArgs
    An array of parameters to set for more control over a serverless database. See Config Parameter below.
    EnhancedVpcRouting bool
    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.
    MaxCapacity int
    The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries, specified in Redshift Processing Units (RPUs).
    Port int
    The port number on which the cluster accepts incoming connections.
    PubliclyAccessible bool
    A value that specifies whether the workgroup can be accessed from a public network.
    SecurityGroupIds []string
    An array of security group IDs to associate with the workgroup.
    SubnetIds []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.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    namespaceName String
    The name of the namespace.
    workgroupName String

    The name of the workgroup.

    The following arguments are optional:

    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 more control over a serverless database. See Config Parameter below.
    enhancedVpcRouting Boolean
    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.
    maxCapacity Integer
    The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries, specified in Redshift Processing Units (RPUs).
    port Integer
    The port number on which the cluster accepts incoming connections.
    publiclyAccessible Boolean
    A value that specifies whether the workgroup can be accessed from a public network.
    securityGroupIds List<String>
    An array of security group IDs to associate with the workgroup.
    subnetIds 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.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    namespaceName string
    The name of the namespace.
    workgroupName string

    The name of the workgroup.

    The following arguments are optional:

    baseCapacity number
    The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
    configParameters WorkgroupConfigParameter[]
    An array of parameters to set for more control over a serverless database. See Config Parameter below.
    enhancedVpcRouting boolean
    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.
    maxCapacity number
    The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries, specified in Redshift Processing Units (RPUs).
    port number
    The port number on which the cluster accepts incoming connections.
    publiclyAccessible boolean
    A value that specifies whether the workgroup can be accessed from a public network.
    securityGroupIds string[]
    An array of security group IDs to associate with the workgroup.
    subnetIds 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.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    namespace_name str
    The name of the namespace.
    workgroup_name str

    The name of the workgroup.

    The following arguments are optional:

    base_capacity int
    The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
    config_parameters Sequence[WorkgroupConfigParameterArgs]
    An array of parameters to set for more control over a serverless database. See Config Parameter below.
    enhanced_vpc_routing bool
    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.
    max_capacity int
    The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries, specified in Redshift Processing Units (RPUs).
    port int
    The port number on which the cluster accepts incoming connections.
    publicly_accessible bool
    A value that specifies whether the workgroup can be accessed from a public network.
    security_group_ids Sequence[str]
    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.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    namespaceName String
    The name of the namespace.
    workgroupName String

    The name of the workgroup.

    The following arguments are optional:

    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 more control over a serverless database. See Config Parameter below.
    enhancedVpcRouting Boolean
    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.
    maxCapacity Number
    The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries, specified in Redshift Processing Units (RPUs).
    port Number
    The port number on which the cluster accepts incoming connections.
    publiclyAccessible Boolean
    A value that specifies whether the workgroup can be accessed from a public network.
    securityGroupIds List<String>
    An array of security group IDs to associate with the workgroup.
    subnetIds 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.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Workgroup resource produces the following output properties:

    Arn string
    Amazon Resource Name (ARN) of the Redshift Serverless Workgroup.
    Endpoints List<WorkgroupEndpoint>
    The endpoint that is created from the workgroup. See Endpoint below.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    WorkgroupId string
    The Redshift Workgroup ID.
    Arn string
    Amazon Resource Name (ARN) of the Redshift Serverless Workgroup.
    Endpoints []WorkgroupEndpoint
    The endpoint that is created from the workgroup. See Endpoint below.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    WorkgroupId string
    The Redshift Workgroup ID.
    arn String
    Amazon Resource Name (ARN) of the Redshift Serverless Workgroup.
    endpoints List<WorkgroupEndpoint>
    The endpoint that is created from the workgroup. See Endpoint below.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    workgroupId String
    The Redshift Workgroup ID.
    arn string
    Amazon Resource Name (ARN) of the Redshift Serverless Workgroup.
    endpoints WorkgroupEndpoint[]
    The endpoint that is created from the workgroup. See Endpoint below.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    workgroupId string
    The Redshift Workgroup ID.
    arn str
    Amazon Resource Name (ARN) of the Redshift Serverless Workgroup.
    endpoints Sequence[WorkgroupEndpoint]
    The endpoint that is created from the workgroup. See Endpoint below.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    workgroup_id str
    The Redshift Workgroup ID.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    workgroupId String
    The Redshift Workgroup ID.

    Look up Existing Workgroup Resource

    Get an existing Workgroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: WorkgroupState, opts?: CustomResourceOptions): Workgroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        base_capacity: Optional[int] = None,
        config_parameters: Optional[Sequence[WorkgroupConfigParameterArgs]] = None,
        endpoints: Optional[Sequence[WorkgroupEndpointArgs]] = None,
        enhanced_vpc_routing: Optional[bool] = None,
        max_capacity: Optional[int] = None,
        namespace_name: Optional[str] = None,
        port: Optional[int] = None,
        publicly_accessible: Optional[bool] = None,
        security_group_ids: Optional[Sequence[str]] = None,
        subnet_ids: Optional[Sequence[str]] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        workgroup_id: Optional[str] = None,
        workgroup_name: Optional[str] = None) -> Workgroup
    func GetWorkgroup(ctx *Context, name string, id IDInput, state *WorkgroupState, opts ...ResourceOption) (*Workgroup, error)
    public static Workgroup Get(string name, Input<string> id, WorkgroupState? state, CustomResourceOptions? opts = null)
    public static Workgroup get(String name, Output<String> id, WorkgroupState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    Amazon Resource Name (ARN) of the Redshift Serverless Workgroup.
    BaseCapacity int
    The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
    ConfigParameters List<WorkgroupConfigParameter>
    An array of parameters to set for more control over a serverless database. See Config Parameter below.
    Endpoints List<WorkgroupEndpoint>
    The endpoint that is created from the workgroup. See Endpoint below.
    EnhancedVpcRouting bool
    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.
    MaxCapacity int
    The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries, specified in Redshift Processing Units (RPUs).
    NamespaceName string
    The name of the namespace.
    Port int
    The port number on which the cluster accepts incoming connections.
    PubliclyAccessible bool
    A value that specifies whether the workgroup can be accessed from a public network.
    SecurityGroupIds List<string>
    An array of security group IDs to associate with the workgroup.
    SubnetIds 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.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    WorkgroupId string
    The Redshift Workgroup ID.
    WorkgroupName string

    The name of the workgroup.

    The following arguments are optional:

    Arn string
    Amazon Resource Name (ARN) of the Redshift Serverless Workgroup.
    BaseCapacity int
    The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
    ConfigParameters []WorkgroupConfigParameterArgs
    An array of parameters to set for more control over a serverless database. See Config Parameter below.
    Endpoints []WorkgroupEndpointArgs
    The endpoint that is created from the workgroup. See Endpoint below.
    EnhancedVpcRouting bool
    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.
    MaxCapacity int
    The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries, specified in Redshift Processing Units (RPUs).
    NamespaceName string
    The name of the namespace.
    Port int
    The port number on which the cluster accepts incoming connections.
    PubliclyAccessible bool
    A value that specifies whether the workgroup can be accessed from a public network.
    SecurityGroupIds []string
    An array of security group IDs to associate with the workgroup.
    SubnetIds []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.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    WorkgroupId string
    The Redshift Workgroup ID.
    WorkgroupName string

    The name of the workgroup.

    The following arguments are optional:

    arn String
    Amazon Resource Name (ARN) of the Redshift Serverless 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 more control over a serverless database. See Config Parameter below.
    endpoints List<WorkgroupEndpoint>
    The endpoint that is created from the workgroup. See Endpoint below.
    enhancedVpcRouting Boolean
    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.
    maxCapacity Integer
    The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries, specified in Redshift Processing Units (RPUs).
    namespaceName String
    The name of the namespace.
    port Integer
    The port number on which the cluster accepts incoming connections.
    publiclyAccessible Boolean
    A value that specifies whether the workgroup can be accessed from a public network.
    securityGroupIds List<String>
    An array of security group IDs to associate with the workgroup.
    subnetIds 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.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    workgroupId String
    The Redshift Workgroup ID.
    workgroupName String

    The name of the workgroup.

    The following arguments are optional:

    arn string
    Amazon Resource Name (ARN) of the Redshift Serverless 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 more control over a serverless database. See Config Parameter below.
    endpoints WorkgroupEndpoint[]
    The endpoint that is created from the workgroup. See Endpoint below.
    enhancedVpcRouting boolean
    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.
    maxCapacity number
    The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries, specified in Redshift Processing Units (RPUs).
    namespaceName string
    The name of the namespace.
    port number
    The port number on which the cluster accepts incoming connections.
    publiclyAccessible boolean
    A value that specifies whether the workgroup can be accessed from a public network.
    securityGroupIds string[]
    An array of security group IDs to associate with the workgroup.
    subnetIds 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.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    workgroupId string
    The Redshift Workgroup ID.
    workgroupName string

    The name of the workgroup.

    The following arguments are optional:

    arn str
    Amazon Resource Name (ARN) of the Redshift Serverless Workgroup.
    base_capacity int
    The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
    config_parameters Sequence[WorkgroupConfigParameterArgs]
    An array of parameters to set for more control over a serverless database. See Config Parameter below.
    endpoints Sequence[WorkgroupEndpointArgs]
    The endpoint that is created from the workgroup. See Endpoint below.
    enhanced_vpc_routing bool
    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.
    max_capacity int
    The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries, specified in Redshift Processing Units (RPUs).
    namespace_name str
    The name of the namespace.
    port int
    The port number on which the cluster accepts incoming connections.
    publicly_accessible bool
    A value that specifies whether the workgroup can be accessed from a public network.
    security_group_ids Sequence[str]
    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.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    workgroup_id str
    The Redshift Workgroup ID.
    workgroup_name str

    The name of the workgroup.

    The following arguments are optional:

    arn String
    Amazon Resource Name (ARN) of the Redshift Serverless 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 more control over a serverless database. See Config Parameter below.
    endpoints List<Property Map>
    The endpoint that is created from the workgroup. See Endpoint below.
    enhancedVpcRouting Boolean
    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.
    maxCapacity Number
    The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries, specified in Redshift Processing Units (RPUs).
    namespaceName String
    The name of the namespace.
    port Number
    The port number on which the cluster accepts incoming connections.
    publiclyAccessible Boolean
    A value that specifies whether the workgroup can be accessed from a public network.
    securityGroupIds List<String>
    An array of security group IDs to associate with the workgroup.
    subnetIds 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.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    workgroupId String
    The Redshift Workgroup ID.
    workgroupName String

    The name of the workgroup.

    The following arguments are optional:

    Supporting Types

    WorkgroupConfigParameter, WorkgroupConfigParameterArgs

    ParameterKey string
    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: max_query_cpu_time, max_query_blocks_read, max_scan_row_count, max_query_execution_time, max_query_queue_time, max_query_cpu_usage_percent, max_query_temp_blocks_to_disk, max_join_row_count and max_nested_loop_join_row_count.
    ParameterValue string
    The value of the parameter to set.
    ParameterKey string
    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: max_query_cpu_time, max_query_blocks_read, max_scan_row_count, max_query_execution_time, max_query_queue_time, max_query_cpu_usage_percent, max_query_temp_blocks_to_disk, max_join_row_count and max_nested_loop_join_row_count.
    ParameterValue string
    The value of the parameter to set.
    parameterKey String
    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: max_query_cpu_time, max_query_blocks_read, max_scan_row_count, max_query_execution_time, max_query_queue_time, max_query_cpu_usage_percent, max_query_temp_blocks_to_disk, max_join_row_count and max_nested_loop_join_row_count.
    parameterValue String
    The value of the parameter to set.
    parameterKey string
    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: max_query_cpu_time, max_query_blocks_read, max_scan_row_count, max_query_execution_time, max_query_queue_time, max_query_cpu_usage_percent, max_query_temp_blocks_to_disk, max_join_row_count and max_nested_loop_join_row_count.
    parameterValue string
    The value of the parameter to set.
    parameter_key str
    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: max_query_cpu_time, max_query_blocks_read, max_scan_row_count, max_query_execution_time, max_query_queue_time, max_query_cpu_usage_percent, max_query_temp_blocks_to_disk, max_join_row_count and max_nested_loop_join_row_count.
    parameter_value str
    The value of the parameter to set.
    parameterKey String
    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: max_query_cpu_time, max_query_blocks_read, max_scan_row_count, max_query_execution_time, max_query_queue_time, max_query_cpu_usage_percent, max_query_temp_blocks_to_disk, max_join_row_count and max_nested_loop_join_row_count.
    parameterValue String
    The value of the parameter to set.

    WorkgroupEndpoint, WorkgroupEndpointArgs

    Address string
    The DNS address of the VPC endpoint.
    Port int
    The port number on which the cluster accepts incoming connections.
    VpcEndpoints List<WorkgroupEndpointVpcEndpoint>
    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 number on which the cluster accepts incoming connections.
    VpcEndpoints []WorkgroupEndpointVpcEndpoint
    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 number on which the cluster accepts incoming connections.
    vpcEndpoints List<WorkgroupEndpointVpcEndpoint>
    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 number on which the cluster accepts incoming connections.
    vpcEndpoints WorkgroupEndpointVpcEndpoint[]
    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 number on which the cluster accepts incoming connections.
    vpc_endpoints Sequence[WorkgroupEndpointVpcEndpoint]
    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 number on which the cluster accepts incoming connections.
    vpcEndpoints List<Property Map>
    The VPC endpoint or the Redshift Serverless workgroup. See VPC Endpoint below.

    WorkgroupEndpointVpcEndpoint, WorkgroupEndpointVpcEndpointArgs

    NetworkInterfaces List<WorkgroupEndpointVpcEndpointNetworkInterface>
    The network interfaces of the endpoint.. See Network Interface below.
    VpcEndpointId string
    The DNS address of the VPC endpoint.
    VpcId string
    The port that Amazon Redshift Serverless listens on.
    NetworkInterfaces []WorkgroupEndpointVpcEndpointNetworkInterface
    The network interfaces of the endpoint.. See Network Interface below.
    VpcEndpointId string
    The DNS address of the VPC endpoint.
    VpcId string
    The port that Amazon Redshift Serverless listens on.
    networkInterfaces List<WorkgroupEndpointVpcEndpointNetworkInterface>
    The network interfaces of the endpoint.. See Network Interface below.
    vpcEndpointId String
    The DNS address of the VPC endpoint.
    vpcId String
    The port that Amazon Redshift Serverless listens on.
    networkInterfaces WorkgroupEndpointVpcEndpointNetworkInterface[]
    The network interfaces of the endpoint.. See Network Interface below.
    vpcEndpointId string
    The DNS address of the VPC endpoint.
    vpcId string
    The port that Amazon Redshift Serverless listens on.
    network_interfaces Sequence[WorkgroupEndpointVpcEndpointNetworkInterface]
    The network interfaces of the endpoint.. See Network Interface below.
    vpc_endpoint_id str
    The DNS address of the VPC endpoint.
    vpc_id str
    The port that Amazon Redshift Serverless listens on.
    networkInterfaces List<Property Map>
    The network interfaces of the endpoint.. See Network Interface below.
    vpcEndpointId String
    The DNS address of the VPC endpoint.
    vpcId String
    The port that Amazon Redshift Serverless listens on.

    WorkgroupEndpointVpcEndpointNetworkInterface, WorkgroupEndpointVpcEndpointNetworkInterfaceArgs

    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.

    Import

    Using pulumi import, import Redshift Serverless Workgroups using the workgroup_name. For example:

    $ pulumi import aws:redshiftserverless/workgroup:Workgroup example example

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws