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, price_performance_target=None, publicly_accessible=None, recovery_point_id=None, security_group_ids=None, snapshot_arn=None, snapshot_name=None, snapshot_owner_account=None, subnet_ids=None, tags=None, track_name=None, workgroup=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]) – The key of the parameter. The options are auto_mv , datestyle , enable_case_sensitive_identifier , enable_user_activity_logging , query_group , search_path , require_ssl , use_fips_ssl , 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 .
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.
price_performance_target (Union[IResolvable, PerformanceTargetProperty, Dict[str, Any], None]) – An object that represents the price performance target settings for the workgroup.
publicly_accessible (Union[bool, IResolvable, None]) – A value that specifies whether the workgroup can be accessible from a public network. Default: - false
recovery_point_id (Optional[str]) – The recovery point id to restore from.
security_group_ids (Optional[Sequence[str]]) – A list of security group IDs to associate with the workgroup.
snapshot_arn (Optional[str]) – The Amazon Resource Name (ARN) of the snapshot to restore from.
snapshot_name (Optional[str]) – The snapshot name to restore from.
snapshot_owner_account (Optional[str]) – The Amazon Web Services account that owns the snapshot.
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.
track_name (Optional[str]) – An optional parameter for the name of the track for the workgroup. If you don’t provide a track name, the workgroup is assigned to the current track.
workgroup (Union[IResolvable, WorkgroupProperty, Dict[str, Any], None]) – The collection of computing resources from which an endpoint is created.

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,
    price_performance_target=redshiftserverless.CfnWorkgroup.PerformanceTargetProperty(
        level=123,
        status="status"
    ),
    publicly_accessible=False,
    recovery_point_id="recoveryPointId",
    security_group_ids=["securityGroupIds"],
    snapshot_arn="snapshotArn",
    snapshot_name="snapshotName",
    snapshot_owner_account="snapshotOwnerAccount",
    subnet_ids=["subnetIds"],
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    track_name="trackName",
    workgroup=redshiftserverless.CfnWorkgroup.WorkgroupProperty(
        base_capacity=123,
        config_parameters=[redshiftserverless.CfnWorkgroup.ConfigParameterProperty(
            parameter_key="parameterKey",
            parameter_value="parameterValue"
        )],
        creation_date="creationDate",
        endpoint=redshiftserverless.CfnWorkgroup.EndpointProperty(
            address="address",
            port=123,
            vpc_endpoints=[redshiftserverless.CfnWorkgroup.VpcEndpointProperty(
                network_interfaces=[redshiftserverless.CfnWorkgroup.NetworkInterfaceProperty(
                    availability_zone="availabilityZone",
                    network_interface_id="networkInterfaceId",
                    private_ip_address="privateIpAddress",
                    subnet_id="subnetId"
                )],
                vpc_endpoint_id="vpcEndpointId",
                vpc_id="vpcId"
            )]
        ),
        enhanced_vpc_routing=False,
        max_capacity=123,
        namespace_name="namespaceName",
        price_performance_target=redshiftserverless.CfnWorkgroup.PerformanceTargetProperty(
            level=123,
            status="status"
        ),
        publicly_accessible=False,
        security_group_ids=["securityGroupIds"],
        status="status",
        subnet_ids=["subnetIds"],
        track_name="trackName",
        workgroup_arn="workgroupArn",
        workgroup_id="workgroupId",
        workgroup_name="workgroupName"
    )
)

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

The key of the parameter.

The options are auto_mv , datestyle , enable_case_sensitive_identifier , enable_user_activity_logging , query_group , search_path , require_ssl , use_fips_ssl , 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 .

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: