Package software.amazon.awscdk.services.redshiftserverless

Class CfnWorkgroup

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.redshiftserverless.CfnWorkgroup
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IWorkgroupRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:44.023Z") @Stability(Stable) public class CfnWorkgroup extends CfnResource implements IInspectable, IWorkgroupRef, ITaggable
The collection of compute resources in Amazon Redshift Serverless.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.redshiftserverless.*;
 CfnWorkgroup cfnWorkgroup = CfnWorkgroup.Builder.create(this, "MyCfnWorkgroup")
         .workgroupName("workgroupName")
         // the properties below are optional
         .baseCapacity(123)
         .configParameters(List.of(ConfigParameterProperty.builder()
                 .parameterKey("parameterKey")
                 .parameterValue("parameterValue")
                 .build()))
         .enhancedVpcRouting(false)
         .maxCapacity(123)
         .namespaceName("namespaceName")
         .port(123)
         .pricePerformanceTarget(PerformanceTargetProperty.builder()
                 .level(123)
                 .status("status")
                 .build())
         .publiclyAccessible(false)
         .recoveryPointId("recoveryPointId")
         .securityGroupIds(List.of("securityGroupIds"))
         .snapshotArn("snapshotArn")
         .snapshotName("snapshotName")
         .snapshotOwnerAccount("snapshotOwnerAccount")
         .subnetIds(List.of("subnetIds"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .trackName("trackName")
         .workgroup(WorkgroupProperty.builder()
                 .baseCapacity(123)
                 .configParameters(List.of(ConfigParameterProperty.builder()
                         .parameterKey("parameterKey")
                         .parameterValue("parameterValue")
                         .build()))
                 .creationDate("creationDate")
                 .endpoint(EndpointProperty.builder()
                         .address("address")
                         .port(123)
                         .vpcEndpoints(List.of(VpcEndpointProperty.builder()
                                 .networkInterfaces(List.of(NetworkInterfaceProperty.builder()
                                         .availabilityZone("availabilityZone")
                                         .networkInterfaceId("networkInterfaceId")
                                         .privateIpAddress("privateIpAddress")
                                         .subnetId("subnetId")
                                         .build()))
                                 .vpcEndpointId("vpcEndpointId")
                                 .vpcId("vpcId")
                                 .build()))
                         .build())
                 .enhancedVpcRouting(false)
                 .maxCapacity(123)
                 .namespaceName("namespaceName")
                 .pricePerformanceTarget(PerformanceTargetProperty.builder()
                         .level(123)
                         .status("status")
                         .build())
                 .publiclyAccessible(false)
                 .securityGroupIds(List.of("securityGroupIds"))
                 .status("status")
                 .subnetIds(List.of("subnetIds"))
                 .trackName("trackName")
                 .workgroupArn("workgroupArn")
                 .workgroupId("workgroupId")
                 .workgroupName("workgroupName")
                 .build())
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnWorkgroup

      protected CfnWorkgroup(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnWorkgroup

      protected CfnWorkgroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnWorkgroup

      @Stability(Stable) public CfnWorkgroup(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnWorkgroupProps props)
      Create a new AWS::RedshiftServerless::Workgroup.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • isCfnWorkgroup

      @Stability(Stable) @NotNull public static Boolean isCfnWorkgroup(@NotNull Object x)
      Checks whether the given object is a CfnWorkgroup.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrWorkgroup

      @Stability(Stable) @NotNull public IResolvable getAttrWorkgroup()

    • getAttrWorkgroupBaseCapacity

      @Stability(Stable) @NotNull public Number getAttrWorkgroupBaseCapacity()
      The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).

    • getAttrWorkgroupConfigParameters

      @Stability(Stable) @NotNull public IResolvable getAttrWorkgroupConfigParameters()

    • getAttrWorkgroupCreationDate

      @Stability(Stable) @NotNull public String getAttrWorkgroupCreationDate()
      The creation date of the workgroup.

    • getAttrWorkgroupEndpoint

      @Stability(Stable) @NotNull public IResolvable getAttrWorkgroupEndpoint()

    • getAttrWorkgroupEndpointAddress

      @Stability(Stable) @NotNull public String getAttrWorkgroupEndpointAddress()
      The DNS address of the VPC endpoint.

    • getAttrWorkgroupEndpointPort

      @Stability(Stable) @NotNull public Number getAttrWorkgroupEndpointPort()
      The custom port to use when connecting to a workgroup.

      Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.

    • getAttrWorkgroupEndpointVpcEndpoints

      @Stability(Stable) @NotNull public IResolvable getAttrWorkgroupEndpointVpcEndpoints()

    • getAttrWorkgroupEnhancedVpcRouting

      @Stability(Stable) @NotNull public IResolvable getAttrWorkgroupEnhancedVpcRouting()
      The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.

    • getAttrWorkgroupMaxCapacity

      @Stability(Stable) @NotNull public Number getAttrWorkgroupMaxCapacity()
      The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries.

      The max capacity is specified in RPUs.

    • getAttrWorkgroupNamespaceName

      @Stability(Stable) @NotNull public String getAttrWorkgroupNamespaceName()
      The namespace the workgroup is associated with.

    • getAttrWorkgroupPubliclyAccessible

      @Stability(Stable) @NotNull public IResolvable getAttrWorkgroupPubliclyAccessible()
      A value that specifies whether the workgroup can be accessible from a public network.

    • getAttrWorkgroupSecurityGroupIds

      @Stability(Stable) @NotNull public List<String> getAttrWorkgroupSecurityGroupIds()
      An array of security group IDs to associate with the workgroup.

    • getAttrWorkgroupStatus

      @Stability(Stable) @NotNull public String getAttrWorkgroupStatus()
      The status of the workgroup.

    • getAttrWorkgroupSubnetIds

      @Stability(Stable) @NotNull public List<String> getAttrWorkgroupSubnetIds()
      An array of subnet IDs the workgroup is associated with.

    • getAttrWorkgroupTrackName

      @Stability(Stable) @NotNull public String getAttrWorkgroupTrackName()
      The name of the track for the workgroup.

    • getAttrWorkgroupWorkgroupArn

      @Stability(Stable) @NotNull public String getAttrWorkgroupWorkgroupArn()
      The Amazon Resource Name (ARN) that links to the workgroup.

    • getAttrWorkgroupWorkgroupId

      @Stability(Stable) @NotNull public String getAttrWorkgroupWorkgroupId()
      The unique identifier of the workgroup.

    • getAttrWorkgroupWorkgroupName

      @Stability(Stable) @NotNull public String getAttrWorkgroupWorkgroupName()
      The name of the workgroup.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getWorkgroupRef

      @Stability(Stable) @NotNull public WorkgroupReference getWorkgroupRef()
      A reference to a Workgroup resource.
      Specified by:
      getWorkgroupRef in interface IWorkgroupRef

    • getWorkgroupName

      @Stability(Stable) @NotNull public String getWorkgroupName()
      The name of the workgroup.

    • setWorkgroupName

      @Stability(Stable) public void setWorkgroupName(@NotNull String value)
      The name of the workgroup.

    • getBaseCapacity

      @Stability(Stable) @Nullable public Number getBaseCapacity()
      The base compute capacity of the workgroup in Redshift Processing Units (RPUs).

    • setBaseCapacity

      @Stability(Stable) public void setBaseCapacity(@Nullable Number value)
      The base compute capacity of the workgroup in Redshift Processing Units (RPUs).

    • getConfigParameters

      @Stability(Stable) @Nullable public Object getConfigParameters()
      The key of the parameter.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnWorkgroup.ConfigParameterProperty>

    • setConfigParameters

      @Stability(Stable) public void setConfigParameters(@Nullable IResolvable value)
      The key of the parameter.

    • setConfigParameters

      @Stability(Stable) public void setConfigParameters(@Nullable List<Object> value)
      The key of the parameter.

    • getEnhancedVpcRouting

      @Stability(Stable) @Nullable public Object getEnhancedVpcRouting()
      The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.

      Returns union: either Boolean or IResolvable

    • setEnhancedVpcRouting

      @Stability(Stable) public void setEnhancedVpcRouting(@Nullable Boolean value)
      The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.

    • setEnhancedVpcRouting

      @Stability(Stable) public void setEnhancedVpcRouting(@Nullable IResolvable value)
      The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.

    • getMaxCapacity

      @Stability(Stable) @Nullable public Number getMaxCapacity()
      The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries.

    • setMaxCapacity

      @Stability(Stable) public void setMaxCapacity(@Nullable Number value)
      The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries.

    • getNamespaceName

      @Stability(Stable) @Nullable public String getNamespaceName()
      The namespace the workgroup is associated with.

    • setNamespaceName

      @Stability(Stable) public void setNamespaceName(@Nullable String value)
      The namespace the workgroup is associated with.

    • getPort

      @Stability(Stable) @Nullable public Number getPort()
      The custom port to use when connecting to a workgroup.

    • setPort

      @Stability(Stable) public void setPort(@Nullable Number value)
      The custom port to use when connecting to a workgroup.

    • getPricePerformanceTarget

      @Stability(Stable) @Nullable public Object getPricePerformanceTarget()
      An object that represents the price performance target settings for the workgroup.

      Returns union: either IResolvable or CfnWorkgroup.PerformanceTargetProperty

    • setPricePerformanceTarget

      @Stability(Stable) public void setPricePerformanceTarget(@Nullable IResolvable value)
      An object that represents the price performance target settings for the workgroup.

    • setPricePerformanceTarget

      @Stability(Stable) public void setPricePerformanceTarget(@Nullable CfnWorkgroup.PerformanceTargetProperty value)
      An object that represents the price performance target settings for the workgroup.

    • getPubliclyAccessible

      @Stability(Stable) @Nullable public Object getPubliclyAccessible()
      A value that specifies whether the workgroup can be accessible from a public network.

      Returns union: either Boolean or IResolvable

    • setPubliclyAccessible

      @Stability(Stable) public void setPubliclyAccessible(@Nullable Boolean value)
      A value that specifies whether the workgroup can be accessible from a public network.

    • setPubliclyAccessible

      @Stability(Stable) public void setPubliclyAccessible(@Nullable IResolvable value)
      A value that specifies whether the workgroup can be accessible from a public network.

    • getRecoveryPointId

      @Stability(Stable) @Nullable public String getRecoveryPointId()
      The recovery point id to restore from.

    • setRecoveryPointId

      @Stability(Stable) public void setRecoveryPointId(@Nullable String value)
      The recovery point id to restore from.

    • getSecurityGroupIds

      @Stability(Stable) @Nullable public List<String> getSecurityGroupIds()
      A list of security group IDs to associate with the workgroup.

    • setSecurityGroupIds

      @Stability(Stable) public void setSecurityGroupIds(@Nullable List<String> value)
      A list of security group IDs to associate with the workgroup.

    • getSnapshotArn

      @Stability(Stable) @Nullable public String getSnapshotArn()
      The Amazon Resource Name (ARN) of the snapshot to restore from.

    • setSnapshotArn

      @Stability(Stable) public void setSnapshotArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the snapshot to restore from.

    • getSnapshotName

      @Stability(Stable) @Nullable public String getSnapshotName()
      The snapshot name to restore from.

    • setSnapshotName

      @Stability(Stable) public void setSnapshotName(@Nullable String value)
      The snapshot name to restore from.

    • getSnapshotOwnerAccount

      @Stability(Stable) @Nullable public String getSnapshotOwnerAccount()
      The Amazon Web Services account that owns the snapshot.

    • setSnapshotOwnerAccount

      @Stability(Stable) public void setSnapshotOwnerAccount(@Nullable String value)
      The Amazon Web Services account that owns the snapshot.

    • getSubnetIds

      @Stability(Stable) @Nullable public List<String> getSubnetIds()
      A list of subnet IDs the workgroup is associated with.

    • setSubnetIds

      @Stability(Stable) public void setSubnetIds(@Nullable List<String> value)
      A list of subnet IDs the workgroup is associated with.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The map of the key-value pairs used to tag the workgroup.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The map of the key-value pairs used to tag the workgroup.

    • getTrackName

      @Stability(Stable) @Nullable public String getTrackName()
      An optional parameter for the name of the track for the workgroup.

    • setTrackName

      @Stability(Stable) public void setTrackName(@Nullable String value)
      An optional parameter for the name of the track for the workgroup.

    • getWorkgroup

      @Stability(Stable) @Nullable public Object getWorkgroup()
      The collection of computing resources from which an endpoint is created.

      Returns union: either IResolvable or CfnWorkgroup.WorkgroupProperty

    • setWorkgroup

      @Stability(Stable) public void setWorkgroup(@Nullable IResolvable value)
      The collection of computing resources from which an endpoint is created.

    • setWorkgroup

      @Stability(Stable) public void setWorkgroup(@Nullable CfnWorkgroup.WorkgroupProperty value)
      The collection of computing resources from which an endpoint is created.