Workgroup ¶

class Workgroup(TypedDict, closed=True):
    workgroup_id: NotRequired["str"]
    """<p>The unique identifier of the workgroup.</p>"""
    workgroup_arn: NotRequired["str"]
    """<p>The Amazon Resource Name (ARN) that links to the workgroup.</p>"""
    workgroup_name: NotRequired[
        "capo_redshift_serverless.types.workgroup_name.WorkgroupName"
    ]
    """<p>The name of the workgroup.</p>"""
    namespace_name: NotRequired["str"]
    """<p>The namespace the workgroup is associated with.</p>"""
    base_capacity: NotRequired["int"]
    """<p>The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).</p>"""
    enhanced_vpc_routing: NotRequired["bool"]
    """<p>The value that specifies whether to enable 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>"""
    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>"""
    subnet_ids: NotRequired[
        "capo_redshift_serverless.types.subnet_id_list.SubnetIdList"
    ]
    """<p>An array of subnet IDs the workgroup is associated with.</p>"""
    status: NotRequired[
        "capo_redshift_serverless.types.workgroup_status.WorkgroupStatus"
    ]
    """<p>The status of the workgroup.</p>"""
    endpoint: NotRequired["capo_redshift_serverless.types.endpoint.Endpoint"]
    """<p>The endpoint that is created from the workgroup.</p>"""
    publicly_accessible: NotRequired["bool"]
    """<p>A value that specifies whether the workgroup can be accessible from a public network.</p>"""
    creation_date: NotRequired["datetime.datetime"]
    """<p>The creation date of 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>"""
    custom_domain_name: NotRequired[
        "capo_redshift_serverless.types.custom_domain_name.CustomDomainName"
    ]
    """<p>The custom domain name associated with the workgroup.</p>"""
    custom_domain_certificate_arn: NotRequired[
        "capo_redshift_serverless.types.custom_domain_certificate_arn_string.CustomDomainCertificateArnString"
    ]
    """<p>The custom domain name’s certificate Amazon resource name (ARN).</p>"""
    custom_domain_certificate_expiry_time: NotRequired["datetime.datetime"]
    """<p>The expiration time for the certificate.</p>"""
    workgroup_version: NotRequired["str"]
    """<p>The Amazon Redshift Serverless version of your workgroup. For more information about Amazon Redshift Serverless versions, see<a href="https://docs.aws.amazon.com/redshift/latest/mgmt/cluster-versions.html">Cluster versions for Amazon Redshift</a>.</p>"""
    patch_version: NotRequired["str"]
    """<p>The patch version of your Amazon Redshift Serverless workgroup. For more information about patch versions, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/cluster-versions.html">Cluster versions for Amazon Redshift</a>.</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>"""
    cross_account_vpcs: NotRequired["capo_redshift_serverless.types.vpc_ids.VpcIds"]
    """<p>A list of VPCs. Each entry is the unique identifier of a virtual private cloud with access to Amazon Redshift Serverless. If all of the VPCs for the grantee are allowed, it shows an asterisk.</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>The name of the track for the workgroup.</p>"""
    pending_track_name: NotRequired[
        "capo_redshift_serverless.types.track_name.TrackName"
    ]
    """<p>The name for the track that you want to assign to the workgroup. When the track changes, the workgroup is switched to the latest workgroup release available for the track. At this point, the track name is applied.</p>"""
    extra_compute_for_automatic_optimization: NotRequired["bool"]
    """<p>A boolean value that, if <code>true</code>, indicates that the workgroup allocates additional compute resources to run automatic optimization operations.</p> <p>Default: false</p>"""