CfnWorkgroupPropsMixin

class aws_cdk.mixins_preview.aws_redshiftserverless.mixins.CfnWorkgroupPropsMixin(props, *, strategy=None)

Bases: Mixin

The collection of compute resources in Amazon Redshift Serverless.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html
CloudformationResource:: AWS::RedshiftServerless::Workgroup
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_redshiftserverless import mixins as redshiftserverless_mixins

cfn_workgroup_props_mixin = redshiftserverless_mixins.CfnWorkgroupPropsMixin(redshiftserverless_mixins.CfnWorkgroupMixinProps(
    base_capacity=123,
    config_parameters=[redshiftserverless_mixins.CfnWorkgroupPropsMixin.ConfigParameterProperty(
        parameter_key="parameterKey",
        parameter_value="parameterValue"
    )],
    enhanced_vpc_routing=False,
    max_capacity=123,
    namespace_name="namespaceName",
    port=123,
    price_performance_target=redshiftserverless_mixins.CfnWorkgroupPropsMixin.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_mixins.CfnWorkgroupPropsMixin.WorkgroupProperty(
        base_capacity=123,
        config_parameters=[redshiftserverless_mixins.CfnWorkgroupPropsMixin.ConfigParameterProperty(
            parameter_key="parameterKey",
            parameter_value="parameterValue"
        )],
        creation_date="creationDate",
        endpoint=redshiftserverless_mixins.CfnWorkgroupPropsMixin.EndpointProperty(
            address="address",
            port=123,
            vpc_endpoints=[redshiftserverless_mixins.CfnWorkgroupPropsMixin.VpcEndpointProperty(
                network_interfaces=[redshiftserverless_mixins.CfnWorkgroupPropsMixin.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_mixins.CfnWorkgroupPropsMixin.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"
    ),
    workgroup_name="workgroupName"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::RedshiftServerless::Workgroup.

Parameters:

props (Union[CfnWorkgroupMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['baseCapacity', 'configParameters', 'enhancedVpcRouting', 'maxCapacity', 'namespaceName', 'port', 'pricePerformanceTarget', 'publiclyAccessible', 'recoveryPointId', 'securityGroupIds', 'snapshotArn', 'snapshotName', 'snapshotOwnerAccount', 'subnetIds', 'tags', 'trackName', 'workgroup', 'workgroupName']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ConfigParameterProperty

class CfnWorkgroupPropsMixin.ConfigParameterProperty(*, parameter_key=None, parameter_value=None)

Bases: object

A array of parameters to set for more control over a serverless database.

Parameters:

parameter_key (Optional[str]) – 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 .
parameter_value (Optional[str]) – The value of the parameter to set.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-configparameter.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.mixins_preview.aws_redshiftserverless import mixins as redshiftserverless_mixins

config_parameter_property = redshiftserverless_mixins.CfnWorkgroupPropsMixin.ConfigParameterProperty(
    parameter_key="parameterKey",
    parameter_value="parameterValue"
)

Attributes

parameter_key

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-properties-redshiftserverless-workgroup-configparameter.html#cfn-redshiftserverless-workgroup-configparameter-parameterkey

parameter_value

The value of the parameter to set.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-configparameter.html#cfn-redshiftserverless-workgroup-configparameter-parametervalue

EndpointProperty

class CfnWorkgroupPropsMixin.EndpointProperty(*, address=None, port=None, vpc_endpoints=None)

Bases: object

The VPC endpoint object.

Parameters:

address (Optional[str]) – The DNS address of the VPC endpoint.
port (Union[int, float, None]) – The port that Amazon Redshift Serverless listens on.
vpc_endpoints (Union[IResolvable, Sequence[Union[IResolvable, VpcEndpointProperty, Dict[str, Any]]], None]) – An array of VpcEndpoint objects.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-endpoint.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.mixins_preview.aws_redshiftserverless import mixins as redshiftserverless_mixins

endpoint_property = redshiftserverless_mixins.CfnWorkgroupPropsMixin.EndpointProperty(
    address="address",
    port=123,
    vpc_endpoints=[redshiftserverless_mixins.CfnWorkgroupPropsMixin.VpcEndpointProperty(
        network_interfaces=[redshiftserverless_mixins.CfnWorkgroupPropsMixin.NetworkInterfaceProperty(
            availability_zone="availabilityZone",
            network_interface_id="networkInterfaceId",
            private_ip_address="privateIpAddress",
            subnet_id="subnetId"
        )],
        vpc_endpoint_id="vpcEndpointId",
        vpc_id="vpcId"
    )]
)

Attributes

address

The DNS address of the VPC endpoint.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-endpoint.html#cfn-redshiftserverless-workgroup-endpoint-address

port

The port that Amazon Redshift Serverless listens on.

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

vpc_endpoints

An array of VpcEndpoint objects.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-endpoint.html#cfn-redshiftserverless-workgroup-endpoint-vpcendpoints

NetworkInterfaceProperty

class CfnWorkgroupPropsMixin.NetworkInterfaceProperty(*, availability_zone=None, network_interface_id=None, private_ip_address=None, subnet_id=None)

Bases: object

Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.

Parameters:

availability_zone (Optional[str]) – The availability Zone.
network_interface_id (Optional[str]) – The unique identifier of the network interface.
private_ip_address (Optional[str]) – The IPv4 address of the network interface within the subnet.
subnet_id (Optional[str]) – The unique identifier of the subnet.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-networkinterface.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.mixins_preview.aws_redshiftserverless import mixins as redshiftserverless_mixins

network_interface_property = redshiftserverless_mixins.CfnWorkgroupPropsMixin.NetworkInterfaceProperty(
    availability_zone="availabilityZone",
    network_interface_id="networkInterfaceId",
    private_ip_address="privateIpAddress",
    subnet_id="subnetId"
)

Attributes

availability_zone

The availability Zone.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-networkinterface.html#cfn-redshiftserverless-workgroup-networkinterface-availabilityzone

network_interface_id

The unique identifier of the network interface.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-networkinterface.html#cfn-redshiftserverless-workgroup-networkinterface-networkinterfaceid

private_ip_address

The IPv4 address of the network interface within the subnet.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-networkinterface.html#cfn-redshiftserverless-workgroup-networkinterface-privateipaddress

subnet_id

The unique identifier of the subnet.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-networkinterface.html#cfn-redshiftserverless-workgroup-networkinterface-subnetid

PerformanceTargetProperty

class CfnWorkgroupPropsMixin.PerformanceTargetProperty(*, level=None, status=None)

Bases: object

An object that represents the price performance target settings for the workgroup.

Parameters:

level (Union[int, float, None]) – The target price performance level for the workgroup. Valid values include 1, 25, 50, 75, and 100. These correspond to the price performance levels LOW_COST, ECONOMICAL, BALANCED, RESOURCEFUL, and HIGH_PERFORMANCE.
status (Optional[str]) – Whether the price performance target is enabled for the workgroup.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-performancetarget.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.mixins_preview.aws_redshiftserverless import mixins as redshiftserverless_mixins

performance_target_property = redshiftserverless_mixins.CfnWorkgroupPropsMixin.PerformanceTargetProperty(
    level=123,
    status="status"
)

Attributes

level

The target price performance level for the workgroup.

Valid values include 1, 25, 50, 75, and 100. These correspond to the price performance levels LOW_COST, ECONOMICAL, BALANCED, RESOURCEFUL, and HIGH_PERFORMANCE.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-performancetarget.html#cfn-redshiftserverless-workgroup-performancetarget-level

status

Whether the price performance target is enabled for the workgroup.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-performancetarget.html#cfn-redshiftserverless-workgroup-performancetarget-status

VpcEndpointProperty

class CfnWorkgroupPropsMixin.VpcEndpointProperty(*, network_interfaces=None, vpc_endpoint_id=None, vpc_id=None)

Bases: object

The connection endpoint for connecting to Amazon Redshift Serverless through the proxy.

Parameters:

network_interfaces (Union[IResolvable, Sequence[Union[IResolvable, NetworkInterfaceProperty, Dict[str, Any]]], None]) – One or more network interfaces of the endpoint. Also known as an interface endpoint.
vpc_endpoint_id (Optional[str]) – The connection endpoint ID for connecting to Amazon Redshift Serverless.
vpc_id (Optional[str]) – The VPC identifier that the endpoint is associated with.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-vpcendpoint.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.mixins_preview.aws_redshiftserverless import mixins as redshiftserverless_mixins

vpc_endpoint_property = redshiftserverless_mixins.CfnWorkgroupPropsMixin.VpcEndpointProperty(
    network_interfaces=[redshiftserverless_mixins.CfnWorkgroupPropsMixin.NetworkInterfaceProperty(
        availability_zone="availabilityZone",
        network_interface_id="networkInterfaceId",
        private_ip_address="privateIpAddress",
        subnet_id="subnetId"
    )],
    vpc_endpoint_id="vpcEndpointId",
    vpc_id="vpcId"
)

Attributes

network_interfaces

One or more network interfaces of the endpoint.

Also known as an interface endpoint.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-vpcendpoint.html#cfn-redshiftserverless-workgroup-vpcendpoint-networkinterfaces

vpc_endpoint_id

The connection endpoint ID for connecting to Amazon Redshift Serverless.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-vpcendpoint.html#cfn-redshiftserverless-workgroup-vpcendpoint-vpcendpointid

vpc_id

The VPC identifier that the endpoint is associated with.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-vpcendpoint.html#cfn-redshiftserverless-workgroup-vpcendpoint-vpcid

WorkgroupProperty

class CfnWorkgroupPropsMixin.WorkgroupProperty(*, base_capacity=None, config_parameters=None, creation_date=None, endpoint=None, enhanced_vpc_routing=None, max_capacity=None, namespace_name=None, price_performance_target=None, publicly_accessible=None, security_group_ids=None, status=None, subnet_ids=None, track_name=None, workgroup_arn=None, workgroup_id=None, workgroup_name=None)

Bases: object

The collection of computing resources from which an endpoint is created.

Parameters:

base_capacity (Union[int, float, None]) – The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
config_parameters (Union[IResolvable, Sequence[Union[IResolvable, ConfigParameterProperty, Dict[str, Any]]], None]) –
An array of parameters to set for advanced control over a database. 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 .
creation_date (Optional[str]) – The creation date of the workgroup.
endpoint (Union[IResolvable, EndpointProperty, Dict[str, Any], None]) – The endpoint that is created from the workgroup.
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.
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.
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.
security_group_ids (Optional[Sequence[str]]) – An array of security group IDs to associate with the workgroup.
status (Optional[str]) – The status of the workgroup.
subnet_ids (Optional[Sequence[str]]) – An array of subnet IDs the workgroup is associated with.
track_name (Optional[str]) – The name of the track for the workgroup.
workgroup_arn (Optional[str]) – The Amazon Resource Name (ARN) that links to the workgroup.
workgroup_id (Optional[str]) – The unique identifier of the workgroup.
workgroup_name (Optional[str]) – The name of the workgroup.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-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.mixins_preview.aws_redshiftserverless import mixins as redshiftserverless_mixins

workgroup_property = redshiftserverless_mixins.CfnWorkgroupPropsMixin.WorkgroupProperty(
    base_capacity=123,
    config_parameters=[redshiftserverless_mixins.CfnWorkgroupPropsMixin.ConfigParameterProperty(
        parameter_key="parameterKey",
        parameter_value="parameterValue"
    )],
    creation_date="creationDate",
    endpoint=redshiftserverless_mixins.CfnWorkgroupPropsMixin.EndpointProperty(
        address="address",
        port=123,
        vpc_endpoints=[redshiftserverless_mixins.CfnWorkgroupPropsMixin.VpcEndpointProperty(
            network_interfaces=[redshiftserverless_mixins.CfnWorkgroupPropsMixin.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_mixins.CfnWorkgroupPropsMixin.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 data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).

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

config_parameters

An array of parameters to set for advanced control over a database.

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-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-configparameters

creation_date

The creation date of the workgroup.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-creationdate

endpoint

The endpoint that is created from the workgroup.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-workgroup.html#cfn-redshiftserverless-workgroup-workgroup-endpoint

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.