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.84.0 (build 5404dcf)", date="2023-06-19T16:30:34.906Z") @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)
         .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();

  • Method Details

    • getWorkgroupName

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

    • getBaseCapacity

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

    • 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 , and max_query_execution_time .

    • 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.

    • getNamespaceName

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

    • 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.

    • getPubliclyAccessible

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

    • getSecurityGroupIds

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

    • getSubnetIds

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

    • getTags

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

    • builder

      @Stability(Stable) static CfnWorkgroupProps.Builder builder()
      Returns:
      a CfnWorkgroupProps.Builder of CfnWorkgroupProps