Package software.amazon.awscdk.services.redshiftserverless

Interface CfnWorkgroup.WorkgroupProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnWorkgroup.WorkgroupProperty.Jsii$Proxy
Enclosing class:
CfnWorkgroup
@Stability(Stable) public static interface CfnWorkgroup.WorkgroupProperty extends software.amazon.jsii.JsiiSerializable
The collection of computing resources from which an endpoint is created.

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.*;
 WorkgroupProperty workgroupProperty = 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)
         .namespaceName("namespaceName")
         .publiclyAccessible(false)
         .securityGroupIds(List.of("securityGroupIds"))
         .status("status")
         .subnetIds(List.of("subnetIds"))
         .workgroupArn("workgroupArn")
         .workgroupId("workgroupId")
         .workgroupName("workgroupName")
         .build();

  • Method Details

    • getBaseCapacity

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

    • getConfigParameters

      @Stability(Stable) @Nullable default Object getConfigParameters()
      An array of parameters to set for advanced control over a database.

      The options are auto_mv , datestyle , enable_case_sensitivity_identifier , enable_user_activity_logging , query_group , , search_path , and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless .

    • getCreationDate

      @Stability(Stable) @Nullable default String getCreationDate()
      The creation date of the workgroup.

    • getEndpoint

      @Stability(Stable) @Nullable default Object getEndpoint()
      The endpoint that is created from the workgroup.

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

    • 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()
      An array of security group IDs to associate with the workgroup.

    • getStatus

      @Stability(Stable) @Nullable default String getStatus()
      The status of the workgroup.

    • getSubnetIds

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

    • getWorkgroupArn

      @Stability(Stable) @Nullable default String getWorkgroupArn()
      The Amazon Resource Name (ARN) that links to the workgroup.

    • getWorkgroupId

      @Stability(Stable) @Nullable default String getWorkgroupId()
      The unique identifier of the workgroup.

    • getWorkgroupName

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

    • builder

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