Workgroup class

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")

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 main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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
	})
}

pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_redshiftserverless_workgroup" "example" {
  namespace_name = "concurrency-scaling"
  workgroup_name = "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.ArrayList;
import java.util.Arrays;
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

Import

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

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

Constructors

Workgroup(String name, {WorkgroupArgs? args, CustomResourceOptions? options}): Creates a new Workgroup. name The Pulumi resource name. args Arguments used to configure this Workgroup. The set of arguments for Workgroup. options Resource options controlling this resource's behavior.
Workgroup.reference(String urn): Creates a typed reference to an existing Workgroup resource.

Properties

arn ↔ Output<String>: ARN of the Redshift Serverless Workgroup.
latefinal
baseCapacity ↔ Output<int>: The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
latefinal
childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
configParameters ↔ Output<List<WorkgroupConfigParameter>>: An array of parameters to set for more control over a serverless database. See Config Parameter below.
latefinal
endpoints ↔ Output<List<WorkgroupEndpoint>>: The endpoint that is created from the workgroup. See Endpoint below.
latefinal
enhancedVpcRouting ↔ Output<bool?>: Value that specifies whether to turn on enhanced VPC routing, which forces Amazon Redshift Serverless to route traffic through your VPC instead of over the internet.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
id ↔ Output<String>: getter/setter pairinherited
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
maxCapacity ↔ Output<int?>: The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries, specified in Redshift Processing Units (RPUs).
latefinal
namespaceName ↔ Output<String>: The name of the namespace.
latefinal
port ↔ Output<int>: The port number on which the cluster accepts incoming connections.
latefinal
pricePerformanceTarget ↔ Output<WorkgroupPricePerformanceTarget>: Price-performance scaling for the workgroup. See Price Performance Target below.
latefinal
publiclyAccessible ↔ Output<bool?>: A value that specifies whether the workgroup can be accessed from a public network.
latefinal
region ↔ Output<String>: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
securityGroupIds ↔ Output<List<String>>: An array of security group IDs to associate with the workgroup.
latefinal
subnetIds ↔ Output<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.
latefinal
tags ↔ Output<Map<String, String>?>: A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>: A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
trackName ↔ Output<String>: The name of the track for the workgroup. If it is current, you get the most up-to-date certified release version with the latest features, security updates, and performance enhancements. If it is trailing, you will be on the previous certified release. For more information, see the following AWS document.
latefinal
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>: latefinalinherited
workgroupId ↔ Output<String>: The Redshift Workgroup ID.
latefinal
workgroupName ↔ Output<String>: The name of the workgroup.
latefinal

Methods

failId(Object error) → void: Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void: Completes all output properties with error.
inherited
failUrn(Object error) → void: Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?: Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String: Returns this resource's logical name.
inherited
getResourceType() → String: Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>: Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void: Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void: Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void: Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>: Serializes resource properties for RPC transmission.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {WorkgroupState? state, CustomResourceOptions? options}) → Workgroup: Gets an existing Workgroup resource's state with the given name and id.

Workgroup class

Example Usage

Import

Constructors

Properties

Methods

Operators

Static Methods

redshiftserverless library