CfnWorkgroupProps

class aws_cdk.aws_redshiftserverless.CfnWorkgroupProps(*, workgroup_name, base_capacity=None, config_parameters=None, enhanced_vpc_routing=None, max_capacity=None, namespace_name=None, port=None, publicly_accessible=None, security_group_ids=None, subnet_ids=None, tags=None)

Bases: object

Properties for defining a CfnWorkgroup.

Parameters:
  • workgroup_name (str) – The name of the workgroup.

  • base_capacity (Union[int, float, None]) – The base compute capacity of the workgroup in Redshift Processing Units (RPUs).

  • config_parameters (Union[IResolvable, Sequence[Union[IResolvable, ConfigParameterProperty, Dict[str, Any]]], None]) – 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 .

  • enhanced_vpc_routing (Union[bool, IResolvable, None]) – 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

  • max_capacity (Union[int, float, None]) – The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.

  • namespace_name (Optional[str]) – The namespace the workgroup is associated with.

  • port (Union[int, float, None]) – The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.

  • publicly_accessible (Union[bool, IResolvable, None]) – A value that specifies whether the workgroup can be accessible from a public network. Default: - false

  • security_group_ids (Optional[Sequence[str]]) – A list of security group IDs to associate with the workgroup.

  • subnet_ids (Optional[Sequence[str]]) – A list of subnet IDs the workgroup is associated with.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The map of the key-value pairs used to tag the workgroup.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_redshiftserverless as redshiftserverless

cfn_workgroup_props = redshiftserverless.CfnWorkgroupProps(
    workgroup_name="workgroupName",

    # the properties below are optional
    base_capacity=123,
    config_parameters=[redshiftserverless.CfnWorkgroup.ConfigParameterProperty(
        parameter_key="parameterKey",
        parameter_value="parameterValue"
    )],
    enhanced_vpc_routing=False,
    max_capacity=123,
    namespace_name="namespaceName",
    port=123,
    publicly_accessible=False,
    security_group_ids=["securityGroupIds"],
    subnet_ids=["subnetIds"],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

base_capacity

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

See:

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

config_parameters

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:

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

enhanced_vpc_routing

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:

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

max_capacity

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

The max capacity is specified in RPUs.

See:

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

namespace_name

The namespace the workgroup is associated with.

See:

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

port

The custom port to use when connecting to a workgroup.

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

See:

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

publicly_accessible

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

Default:
  • false

See:

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

security_group_ids

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

See:

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

subnet_ids

A list of subnet IDs the workgroup is associated with.

See:

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

tags

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

See:

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

workgroup_name

The name of the workgroup.

See:

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