CfnWorkgroup

class aws_cdk.aws_redshiftserverless.CfnWorkgroup(scope, id, *, 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: CfnResource

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
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 = redshiftserverless.CfnWorkgroup(self, "MyCfnWorkgroup",
    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"
    )]
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::RedshiftServerless::Workgroup'

attr_workgroup

Workgroup

Type:: cloudformationAttribute

attr_workgroup_base_capacity

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

CloudformationAttribute:: Workgroup.BaseCapacity

attr_workgroup_config_parameters

Workgroup.ConfigParameters

Type:: cloudformationAttribute

attr_workgroup_creation_date

The creation date of the workgroup.

CloudformationAttribute:: Workgroup.CreationDate

attr_workgroup_endpoint

Workgroup.Endpoint

Type:: cloudformationAttribute

attr_workgroup_endpoint_address

The DNS address of the VPC endpoint.

CloudformationAttribute:: Workgroup.Endpoint.Address

attr_workgroup_endpoint_port

The custom port to use when connecting to a workgroup.

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

CloudformationAttribute:: Workgroup.Endpoint.Port

attr_workgroup_endpoint_vpc_endpoints

Workgroup.Endpoint.VpcEndpoints

Type:: cloudformationAttribute

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

CloudformationAttribute:: Workgroup.EnhancedVpcRouting

attr_workgroup_max_capacity

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

The max capacity is specified in RPUs.

CloudformationAttribute:: Workgroup.MaxCapacity

attr_workgroup_namespace_name

The namespace the workgroup is associated with.

CloudformationAttribute:: Workgroup.NamespaceName

attr_workgroup_publicly_accessible

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

CloudformationAttribute:: Workgroup.PubliclyAccessible

attr_workgroup_security_group_ids

An array of security group IDs to associate with the workgroup.

CloudformationAttribute:: Workgroup.SecurityGroupIds

attr_workgroup_status

The status of the workgroup.

CloudformationAttribute:: Workgroup.Status

attr_workgroup_subnet_ids

An array of subnet IDs the workgroup is associated with.

CloudformationAttribute:: Workgroup.SubnetIds

attr_workgroup_workgroup_arn

The Amazon Resource Name (ARN) that links to the workgroup.

CloudformationAttribute:: Workgroup.WorkgroupArn

attr_workgroup_workgroup_id

The unique identifier of the workgroup.

CloudformationAttribute:: Workgroup.WorkgroupId

attr_workgroup_workgroup_name

The name of the workgroup.

CloudformationAttribute:: Workgroup.WorkgroupName

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

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

config_parameters: A list of parameters to set for finer control over a database.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

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.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

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

namespace_name: The namespace the workgroup is associated with.

node: The tree node.

port: The custom port to use when connecting to a workgroup.

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

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

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

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

subnet_ids: A list of subnet IDs the workgroup is associated with.

tags: Tag Manager which manages the tags for this resource.

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

workgroup_name: The name of the workgroup.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

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

ConfigParameterProperty

class CfnWorkgroup.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 datestyle , enable_user_activity_logging , query_group , search_path , max_query_execution_time , and require_ssl .
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 import aws_redshiftserverless as redshiftserverless

config_parameter_property = redshiftserverless.CfnWorkgroup.ConfigParameterProperty(
    parameter_key="parameterKey",
    parameter_value="parameterValue"
)

Attributes

parameter_key

The key of the parameter.

The 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-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 CfnWorkgroup.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 import aws_redshiftserverless as redshiftserverless

endpoint_property = 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"
    )]
)

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 CfnWorkgroup.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 import aws_redshiftserverless as redshiftserverless

network_interface_property = redshiftserverless.CfnWorkgroup.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

VpcEndpointProperty

class CfnWorkgroup.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 import aws_redshiftserverless as redshiftserverless

vpc_endpoint_property = 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"
)

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 CfnWorkgroup.WorkgroupProperty(*, base_capacity=None, config_parameters=None, creation_date=None, endpoint=None, enhanced_vpc_routing=None, max_capacity=None, namespace_name=None, publicly_accessible=None, security_group_ids=None, status=None, subnet_ids=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.
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.
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 import aws_redshiftserverless as redshiftserverless

workgroup_property = 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",
    publicly_accessible=False,
    security_group_ids=["securityGroupIds"],
    status="status",
    subnet_ids=["subnetIds"],
    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.