Skip to content

UpdateWorkgroupRequest

Source code in docs_src/capo_redshift_serverless/types/update_workgroup_request.py
class UpdateWorkgroupRequest(TypedDict, closed=True):
    workgroup_name: "capo_redshift_serverless.types.workgroup_name.WorkgroupName"
    """<p>The name of the workgroup to update. You can't update the name of a workgroup once it is created.</p>"""
    base_capacity: NotRequired["int"]
    """<p>The new base data warehouse capacity in Redshift Processing Units (RPUs).</p>"""
    enhanced_vpc_routing: NotRequired["bool"]
    """<p>The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.</p>"""
    config_parameters: NotRequired[
        "capo_redshift_serverless.types.config_parameter_list.ConfigParameterList"
    ]
    """<p>An array of parameters to set for advanced control over a database. The options are <code>auto_mv</code>, <code>datestyle</code>, <code>enable_case_sensitive_identifier</code>, <code>enable_user_activity_logging</code>, <code>query_group</code>, <code>search_path</code>, <code>require_ssl</code>, <code>use_fips_ssl</code>, and either <code>wlm_json_configuration</code> or query monitoring metrics that let you define performance boundaries. You can either specify individual query monitoring metrics (such as <code>max_scan_row_count</code>, <code>max_query_execution_time</code>) or use <code>wlm_json_configuration</code> to define query queues with rules, but not both. If you're using <code>wlm_json_configuration</code>, the maximum size of <code>parameterValue</code> is 8000 characters. For more information about query monitoring rules and available metrics, see <a href="https://docs.aws.amazon.com/redshift/latest/dg/cm-c-wlm-query-monitoring-rules.html#cm-c-wlm-query-monitoring-metrics-serverless"> Query monitoring metrics for Amazon Redshift Serverless</a>.</p>"""
    publicly_accessible: NotRequired["bool"]
    """<p>A value that specifies whether the workgroup can be accessible from a public network.</p>"""
    subnet_ids: NotRequired[
        "capo_redshift_serverless.types.subnet_id_list.SubnetIdList"
    ]
    """<p>An array of VPC subnet IDs to associate with the workgroup.</p>"""
    security_group_ids: NotRequired[
        "capo_redshift_serverless.types.security_group_id_list.SecurityGroupIdList"
    ]
    """<p>An array of security group IDs to associate with the workgroup.</p>"""
    port: NotRequired["int"]
    """<p>The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.</p>"""
    max_capacity: NotRequired["int"]
    """<p>The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.</p>"""
    ip_address_type: NotRequired[
        "capo_redshift_serverless.types.ip_address_type.IpAddressType"
    ]
    """<p>The IP address type that the workgroup supports. Possible values are <code>ipv4</code> and <code>dualstack</code>.</p>"""
    price_performance_target: NotRequired[
        "capo_redshift_serverless.types.performance_target.PerformanceTarget"
    ]
    """<p>An object that represents the price performance target settings for the workgroup.</p>"""
    track_name: NotRequired["capo_redshift_serverless.types.track_name.TrackName"]
    """<p>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 <code>current</code> track.</p>"""
    extra_compute_for_automatic_optimization: NotRequired["bool"]
    """<p>If <code>true</code>, allocates additional compute resources for running automatic optimization operations.</p> <p>Default: false</p>"""

base_capacity instance-attribute

base_capacity: NotRequired[int]

The new base data warehouse capacity in Redshift Processing Units (RPUs).

config_parameters instance-attribute

config_parameters: NotRequired[ConfigParameterList]

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 either wlm_json_configuration or query monitoring metrics that let you define performance boundaries. You can either specify individual query monitoring metrics (such as max_scan_row_count, max_query_execution_time) or use wlm_json_configuration to define query queues with rules, but not both. If you're using wlm_json_configuration, the maximum size of parameterValue is 8000 characters. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.

enhanced_vpc_routing instance-attribute

enhanced_vpc_routing: NotRequired[bool]

The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.

extra_compute_for_automatic_optimization instance-attribute

extra_compute_for_automatic_optimization: NotRequired[bool]

If true, allocates additional compute resources for running automatic optimization operations.

Default: false

ip_address_type instance-attribute

ip_address_type: NotRequired[IpAddressType]

The IP address type that the workgroup supports. Possible values are ipv4 and dualstack.

max_capacity instance-attribute

max_capacity: NotRequired[int]

The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.

port instance-attribute

port: NotRequired[int]

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 instance-attribute

price_performance_target: NotRequired[PerformanceTarget]

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

publicly_accessible instance-attribute

publicly_accessible: NotRequired[bool]

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

security_group_ids instance-attribute

security_group_ids: NotRequired[SecurityGroupIdList]

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

subnet_ids instance-attribute

subnet_ids: NotRequired[SubnetIdList]

An array of VPC subnet IDs to associate with the workgroup.

track_name instance-attribute

track_name: NotRequired[TrackName]

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_name instance-attribute

workgroup_name: WorkgroupName

The name of the workgroup to update. You can't update the name of a workgroup once it is created.