aws_sdk_redshiftserverless/client/
update_workgroup.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`UpdateWorkgroup`](crate::operation::update_workgroup::builders::UpdateWorkgroupFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`workgroup_name(impl Into<String>)`](crate::operation::update_workgroup::builders::UpdateWorkgroupFluentBuilder::workgroup_name) / [`set_workgroup_name(Option<String>)`](crate::operation::update_workgroup::builders::UpdateWorkgroupFluentBuilder::set_workgroup_name):<br>required: **true**<br><p>The name of the workgroup to update. You can't update the name of a workgroup once it is created.</p><br>
7    ///   - [`base_capacity(i32)`](crate::operation::update_workgroup::builders::UpdateWorkgroupFluentBuilder::base_capacity) / [`set_base_capacity(Option<i32>)`](crate::operation::update_workgroup::builders::UpdateWorkgroupFluentBuilder::set_base_capacity):<br>required: **false**<br><p>The new base data warehouse capacity in Redshift Processing Units (RPUs).</p><br>
8    ///   - [`enhanced_vpc_routing(bool)`](crate::operation::update_workgroup::builders::UpdateWorkgroupFluentBuilder::enhanced_vpc_routing) / [`set_enhanced_vpc_routing(Option<bool>)`](crate::operation::update_workgroup::builders::UpdateWorkgroupFluentBuilder::set_enhanced_vpc_routing):<br>required: **false**<br><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><br>
9    ///   - [`config_parameters(ConfigParameter)`](crate::operation::update_workgroup::builders::UpdateWorkgroupFluentBuilder::config_parameters) / [`set_config_parameters(Option<Vec::<ConfigParameter>>)`](crate::operation::update_workgroup::builders::UpdateWorkgroupFluentBuilder::set_config_parameters):<br>required: **false**<br><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 query monitoring metrics that let you define performance boundaries. 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><br>
10    ///   - [`publicly_accessible(bool)`](crate::operation::update_workgroup::builders::UpdateWorkgroupFluentBuilder::publicly_accessible) / [`set_publicly_accessible(Option<bool>)`](crate::operation::update_workgroup::builders::UpdateWorkgroupFluentBuilder::set_publicly_accessible):<br>required: **false**<br><p>A value that specifies whether the workgroup can be accessible from a public network.</p><br>
11    ///   - [`subnet_ids(impl Into<String>)`](crate::operation::update_workgroup::builders::UpdateWorkgroupFluentBuilder::subnet_ids) / [`set_subnet_ids(Option<Vec::<String>>)`](crate::operation::update_workgroup::builders::UpdateWorkgroupFluentBuilder::set_subnet_ids):<br>required: **false**<br><p>An array of VPC subnet IDs to associate with the workgroup.</p><br>
12    ///   - [`security_group_ids(impl Into<String>)`](crate::operation::update_workgroup::builders::UpdateWorkgroupFluentBuilder::security_group_ids) / [`set_security_group_ids(Option<Vec::<String>>)`](crate::operation::update_workgroup::builders::UpdateWorkgroupFluentBuilder::set_security_group_ids):<br>required: **false**<br><p>An array of security group IDs to associate with the workgroup.</p><br>
13    ///   - [`port(i32)`](crate::operation::update_workgroup::builders::UpdateWorkgroupFluentBuilder::port) / [`set_port(Option<i32>)`](crate::operation::update_workgroup::builders::UpdateWorkgroupFluentBuilder::set_port):<br>required: **false**<br><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><br>
14    ///   - [`max_capacity(i32)`](crate::operation::update_workgroup::builders::UpdateWorkgroupFluentBuilder::max_capacity) / [`set_max_capacity(Option<i32>)`](crate::operation::update_workgroup::builders::UpdateWorkgroupFluentBuilder::set_max_capacity):<br>required: **false**<br><p>The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.</p><br>
15    ///   - [`ip_address_type(impl Into<String>)`](crate::operation::update_workgroup::builders::UpdateWorkgroupFluentBuilder::ip_address_type) / [`set_ip_address_type(Option<String>)`](crate::operation::update_workgroup::builders::UpdateWorkgroupFluentBuilder::set_ip_address_type):<br>required: **false**<br><p>The IP address type that the workgroup supports. Possible values are <code>ipv4</code> and <code>dualstack</code>.</p><br>
16    ///   - [`price_performance_target(PerformanceTarget)`](crate::operation::update_workgroup::builders::UpdateWorkgroupFluentBuilder::price_performance_target) / [`set_price_performance_target(Option<PerformanceTarget>)`](crate::operation::update_workgroup::builders::UpdateWorkgroupFluentBuilder::set_price_performance_target):<br>required: **false**<br><p>An object that represents the price performance target settings for the workgroup.</p><br>
17    ///   - [`track_name(impl Into<String>)`](crate::operation::update_workgroup::builders::UpdateWorkgroupFluentBuilder::track_name) / [`set_track_name(Option<String>)`](crate::operation::update_workgroup::builders::UpdateWorkgroupFluentBuilder::set_track_name):<br>required: **false**<br><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><br>
18    /// - On success, responds with [`UpdateWorkgroupOutput`](crate::operation::update_workgroup::UpdateWorkgroupOutput) with field(s):
19    ///   - [`workgroup(Option<Workgroup>)`](crate::operation::update_workgroup::UpdateWorkgroupOutput::workgroup): <p>The updated workgroup object.</p>
20    /// - On failure, responds with [`SdkError<UpdateWorkgroupError>`](crate::operation::update_workgroup::UpdateWorkgroupError)
21    pub fn update_workgroup(&self) -> crate::operation::update_workgroup::builders::UpdateWorkgroupFluentBuilder {
22        crate::operation::update_workgroup::builders::UpdateWorkgroupFluentBuilder::new(self.handle.clone())
23    }
24}