Package com.pulumi.aws.redshiftserverless

Class Workgroup

  • public class Workgroup
extends com.pulumi.resources.CustomResource
    Creates a new Amazon Redshift Serverless Workgroup. ## Example Usage 
     
 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());
 
     }
 }
    ## Import Using `pulumi import`, import Redshift Serverless Workgroups using the `workgroupName`. For example: ```sh $ pulumi import aws:redshiftserverless/workgroup:Workgroup example example ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Workgroup​(java.lang.String name)  
      Workgroup​(java.lang.String name, WorkgroupArgs args)  
      Workgroup​(java.lang.String name, WorkgroupArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.Integer> baseCapacity()  
      com.pulumi.core.Output<java.util.List<WorkgroupConfigParameter>> configParameters()  
      com.pulumi.core.Output<java.util.List<WorkgroupEndpoint>> endpoints()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enhancedVpcRouting()  
      static Workgroup get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, WorkgroupState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> maxCapacity()  
      com.pulumi.core.Output<java.lang.String> namespaceName()  
      com.pulumi.core.Output<java.lang.Integer> port()  
      com.pulumi.core.Output<WorkgroupPricePerformanceTarget> pricePerformanceTarget()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> publiclyAccessible()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> securityGroupIds()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> subnetIds()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.lang.String> trackName()  
      com.pulumi.core.Output<java.lang.String> workgroupId()  
      com.pulumi.core.Output<java.lang.String> workgroupName()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Workgroup

        public Workgroup​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Workgroup

        public Workgroup​(java.lang.String name,
                 WorkgroupArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Workgroup

        public Workgroup​(java.lang.String name,
                 WorkgroupArgs args,
                 @Nullable
                 com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the Redshift Serverless Workgroup.

      • baseCapacity

        public com.pulumi.core.Output<java.lang.Integer> baseCapacity()
        Returns:
        The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).

      • configParameters

        public com.pulumi.core.Output<java.util.List<WorkgroupConfigParameter>> configParameters()
        Returns:
        An array of parameters to set for more control over a serverless database. See `Config Parameter` below.

      • endpoints

        public com.pulumi.core.Output<java.util.List<WorkgroupEndpoint>> endpoints()
        Returns:
        The endpoint that is created from the workgroup. See `Endpoint` below.

      • enhancedVpcRouting

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enhancedVpcRouting()
        Returns:
        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.

      • maxCapacity

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> maxCapacity()
        Returns:
        The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries, specified in Redshift Processing Units (RPUs).

      • namespaceName

        public com.pulumi.core.Output<java.lang.String> namespaceName()
        Returns:
        The name of the namespace.

      • port

        public com.pulumi.core.Output<java.lang.Integer> port()
        Returns:
        The port number on which the cluster accepts incoming connections.

      • pricePerformanceTarget

        public com.pulumi.core.Output<WorkgroupPricePerformanceTarget> pricePerformanceTarget()
        Returns:
        Price-performance scaling for the workgroup. See `Price Performance Target` below.

      • publiclyAccessible

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> publiclyAccessible()
        Returns:
        A value that specifies whether the workgroup can be accessed from a public network.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • securityGroupIds

        public com.pulumi.core.Output<java.util.List<java.lang.String>> securityGroupIds()
        Returns:
        An array of security group IDs to associate with the workgroup.

      • subnetIds

        public com.pulumi.core.Output<java.util.List<java.lang.String>> subnetIds()
        Returns:
        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](https://docs.aws.amazon.com/redshift/latest/mgmt/serverless-known-issues.html).

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        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.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • trackName

        public com.pulumi.core.Output<java.lang.String> trackName()
        Returns:
        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](https://docs.aws.amazon.com/redshift/latest/mgmt/tracks.html).

      • workgroupId

        public com.pulumi.core.Output<java.lang.String> workgroupId()
        Returns:
        The Redshift Workgroup ID.

      • workgroupName

        public com.pulumi.core.Output<java.lang.String> workgroupName()
        Returns:
        The name of the workgroup. The following arguments are optional:

      • get

        public static Workgroup get​(java.lang.String name,
                            com.pulumi.core.Output<java.lang.String> id,
                            @Nullable
                            WorkgroupState state,
                            @Nullable
                            com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.