Package software.amazon.awscdk.services.redshiftserverless

Class CfnWorkgroup

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.redshiftserverless.CfnWorkgroup
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:34.900Z") @Stability(Stable) public class CfnWorkgroup extends CfnResource implements IInspectable
A CloudFormation AWS::RedshiftServerless::Workgroup.

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)
         .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();

  • 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 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 -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

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

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

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

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

    • 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()
      The map of the key-value pairs used to tag the workgroup.

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

    • setConfigParameters

      @Stability(Stable) public void setConfigParameters(@Nullable IResolvable value)
      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 .

    • setConfigParameters

      @Stability(Stable) public void setConfigParameters(@Nullable List<Object> value)
      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 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.

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

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

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

    • setPort

      @Stability(Stable) public void setPort(@Nullable Number value)
      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 public Object getPubliclyAccessible()
      A value that specifies whether the workgroup can be accessible from a public network.

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

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

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