Package software.amazon.awscdk.services.redshiftserverless

Interface CfnWorkgroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWorkgroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:15.024Z")
@Stability(Stable)
public interface CfnWorkgroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnWorkgroup.

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.*;
 CfnWorkgroupProps cfnWorkgroupProps = CfnWorkgroupProps.builder()
         .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)
         .publiclyAccessible(false)
         .securityGroupIds(List.of("securityGroupIds"))
         .subnetIds(List.of("subnetIds"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnWorkgroupProps.Builder	A builder for CfnWorkgroupProps
static final class	CfnWorkgroupProps.Jsii$Proxy	An implementation for CfnWorkgroupProps

Method Summary

Modifier and Type	Method	Description
static CfnWorkgroupProps.Builder	builder()
default Number	getBaseCapacity()	The base compute capacity of the workgroup in Redshift Processing Units (RPUs).
default Object	getConfigParameters()	A list of parameters to set for finer control over a database.
default 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.
default Number	getMaxCapacity()	The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries.
default String	getNamespaceName()	The namespace the workgroup is associated with.
default Number	getPort()	The custom port to use when connecting to a workgroup.
default Object	getPubliclyAccessible()	A value that specifies whether the workgroup can be accessible from a public network.
default List<String>	getSecurityGroupIds()	A list of security group IDs to associate with the workgroup.
default List<String>	getSubnetIds()	A list of subnet IDs the workgroup is associated with.
default List<CfnTag>	getTags()	The map of the key-value pairs used to tag the workgroup.
String	getWorkgroupName()	The name of the workgroup.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getWorkgroupName

@Stability(Stable)
@NotNull
String getWorkgroupName()

The name of the workgroup.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-workgroupname

getBaseCapacity

@Stability(Stable)
@Nullable
default Number getBaseCapacity()

The base compute capacity of the workgroup in Redshift Processing Units (RPUs).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-basecapacity

getConfigParameters

@Stability(Stable)
@Nullable
default Object getConfigParameters()

A list of parameters to set for finer control over a database.

Available options are datestyle , enable_user_activity_logging , query_group , search_path , max_query_execution_time , and require_ssl .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-configparameters

getEnhancedVpcRouting

@Stability(Stable)
@Nullable
default 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.

Default: - false

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-enhancedvpcrouting

getMaxCapacity

@Stability(Stable)
@Nullable
default Number getMaxCapacity()

The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries.

The max capacity is specified in RPUs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-maxcapacity

getNamespaceName

@Stability(Stable)
@Nullable
default String getNamespaceName()

The namespace the workgroup is associated with.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-namespacename

getPort

@Stability(Stable)
@Nullable
default Number getPort()

The custom port to use when connecting to a workgroup.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-port

getPubliclyAccessible

@Stability(Stable)
@Nullable
default Object getPubliclyAccessible()

A value that specifies whether the workgroup can be accessible from a public network.

Default: - false

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-publiclyaccessible

getSecurityGroupIds

@Stability(Stable)
@Nullable
default List<String> getSecurityGroupIds()

A list of security group IDs to associate with the workgroup.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-securitygroupids

getSubnetIds

@Stability(Stable)
@Nullable
default List<String> getSubnetIds()

A list of subnet IDs the workgroup is associated with.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-subnetids

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The map of the key-value pairs used to tag the workgroup.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-tags

builder

@Stability(Stable)
static CfnWorkgroupProps.Builder builder()

Returns:

a CfnWorkgroupProps.Builder of CfnWorkgroupProps