Struct WorkGroupConfigurationUpdatesBuilder 

#[non_exhaustive]
pub struct WorkGroupConfigurationUpdatesBuilder { /* private fields */ }

A builder for WorkGroupConfigurationUpdates.

Implementations

impl WorkGroupConfigurationUpdatesBuilder

pub fn enforce_work_group_configuration(self, input: bool) -> Self

If set to "true", the settings for the workgroup override client-side settings. If set to "false" client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings.

pub fn set_enforce_work_group_configuration(self, input: Option<bool>) -> Self

If set to "true", the settings for the workgroup override client-side settings. If set to "false" client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings.

pub fn get_enforce_work_group_configuration(&self) -> &Option<bool>

If set to "true", the settings for the workgroup override client-side settings. If set to "false" client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings.

pub fn result_configuration_updates( self, input: ResultConfigurationUpdates, ) -> Self

The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.

pub fn set_result_configuration_updates( self, input: Option<ResultConfigurationUpdates>, ) -> Self

The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.

pub fn get_result_configuration_updates( &self, ) -> &Option<ResultConfigurationUpdates>

The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.

pub fn managed_query_results_configuration_updates( self, input: ManagedQueryResultsConfigurationUpdates, ) -> Self

Updates configuration information for managed query results in the workgroup.

pub fn set_managed_query_results_configuration_updates( self, input: Option<ManagedQueryResultsConfigurationUpdates>, ) -> Self

Updates configuration information for managed query results in the workgroup.

pub fn get_managed_query_results_configuration_updates( &self, ) -> &Option<ManagedQueryResultsConfigurationUpdates>

Updates configuration information for managed query results in the workgroup.

pub fn publish_cloud_watch_metrics_enabled(self, input: bool) -> Self

Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.

pub fn set_publish_cloud_watch_metrics_enabled( self, input: Option<bool>, ) -> Self

Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.

pub fn get_publish_cloud_watch_metrics_enabled(&self) -> &Option<bool>

Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.

pub fn bytes_scanned_cutoff_per_query(self, input: i64) -> Self

The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.

pub fn set_bytes_scanned_cutoff_per_query(self, input: Option<i64>) -> Self

The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.

pub fn get_bytes_scanned_cutoff_per_query(&self) -> &Option<i64>

The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.

pub fn remove_bytes_scanned_cutoff_per_query(self, input: bool) -> Self

Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery

pub fn set_remove_bytes_scanned_cutoff_per_query( self, input: Option<bool>, ) -> Self

Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery

pub fn get_remove_bytes_scanned_cutoff_per_query(&self) -> &Option<bool>

Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery

pub fn requester_pays_enabled(self, input: bool) -> Self

If set to true, allows members assigned to a workgroup to specify Amazon S3 Requester Pays buckets in queries. If set to false, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide.

pub fn set_requester_pays_enabled(self, input: Option<bool>) -> Self

If set to true, allows members assigned to a workgroup to specify Amazon S3 Requester Pays buckets in queries. If set to false, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide.

pub fn get_requester_pays_enabled(&self) -> &Option<bool>

If set to true, allows members assigned to a workgroup to specify Amazon S3 Requester Pays buckets in queries. If set to false, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide.

pub fn engine_version(self, input: EngineVersion) -> Self

The engine version requested when a workgroup is updated. After the update, all queries on the workgroup run on the requested engine version. If no value was previously set, the default is Auto. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

pub fn set_engine_version(self, input: Option<EngineVersion>) -> Self

The engine version requested when a workgroup is updated. After the update, all queries on the workgroup run on the requested engine version. If no value was previously set, the default is Auto. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

pub fn get_engine_version(&self) -> &Option<EngineVersion>

The engine version requested when a workgroup is updated. After the update, all queries on the workgroup run on the requested engine version. If no value was previously set, the default is Auto. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

pub fn remove_customer_content_encryption_configuration( self, input: bool, ) -> Self

Removes content encryption configuration from an Apache Spark-enabled Athena workgroup.

pub fn set_remove_customer_content_encryption_configuration( self, input: Option<bool>, ) -> Self

Removes content encryption configuration from an Apache Spark-enabled Athena workgroup.

pub fn get_remove_customer_content_encryption_configuration( &self, ) -> &Option<bool>

Removes content encryption configuration from an Apache Spark-enabled Athena workgroup.

pub fn additional_configuration(self, input: impl Into<String>) -> Self

Contains a user defined string in JSON format for a Spark-enabled workgroup.

pub fn set_additional_configuration(self, input: Option<String>) -> Self

Contains a user defined string in JSON format for a Spark-enabled workgroup.

pub fn get_additional_configuration(&self) -> &Option<String>

Contains a user defined string in JSON format for a Spark-enabled workgroup.

pub fn execution_role(self, input: impl Into<String>) -> Self

The ARN of the execution role used to access user resources for Spark sessions and Identity Center enabled workgroups. This property applies only to Spark enabled workgroups and Identity Center enabled workgroups.

pub fn set_execution_role(self, input: Option<String>) -> Self

The ARN of the execution role used to access user resources for Spark sessions and Identity Center enabled workgroups. This property applies only to Spark enabled workgroups and Identity Center enabled workgroups.

pub fn get_execution_role(&self) -> &Option<String>

The ARN of the execution role used to access user resources for Spark sessions and Identity Center enabled workgroups. This property applies only to Spark enabled workgroups and Identity Center enabled workgroups.

pub fn customer_content_encryption_configuration( self, input: CustomerContentEncryptionConfiguration, ) -> Self

Specifies the customer managed KMS key that is used to encrypt the user's data stores in Athena. When an Amazon Web Services managed key is used, this value is null. This setting does not apply to Athena SQL workgroups.

pub fn set_customer_content_encryption_configuration( self, input: Option<CustomerContentEncryptionConfiguration>, ) -> Self

Specifies the customer managed KMS key that is used to encrypt the user's data stores in Athena. When an Amazon Web Services managed key is used, this value is null. This setting does not apply to Athena SQL workgroups.

pub fn get_customer_content_encryption_configuration( &self, ) -> &Option<CustomerContentEncryptionConfiguration>

Specifies the customer managed KMS key that is used to encrypt the user's data stores in Athena. When an Amazon Web Services managed key is used, this value is null. This setting does not apply to Athena SQL workgroups.

pub fn enable_minimum_encryption_configuration(self, input: bool) -> Self

Enforces a minimal level of encryption for the workgroup for query and calculation results that are written to Amazon S3. When enabled, workgroup users can set encryption only to the minimum level set by the administrator or higher when they submit queries. This setting does not apply to Spark-enabled workgroups.

The EnforceWorkGroupConfiguration setting takes precedence over the EnableMinimumEncryptionConfiguration flag. This means that if EnforceWorkGroupConfiguration is true, the EnableMinimumEncryptionConfiguration flag is ignored, and the workgroup configuration for encryption is used.

pub fn set_enable_minimum_encryption_configuration( self, input: Option<bool>, ) -> Self

Enforces a minimal level of encryption for the workgroup for query and calculation results that are written to Amazon S3. When enabled, workgroup users can set encryption only to the minimum level set by the administrator or higher when they submit queries. This setting does not apply to Spark-enabled workgroups.

The EnforceWorkGroupConfiguration setting takes precedence over the EnableMinimumEncryptionConfiguration flag. This means that if EnforceWorkGroupConfiguration is true, the EnableMinimumEncryptionConfiguration flag is ignored, and the workgroup configuration for encryption is used.

pub fn get_enable_minimum_encryption_configuration(&self) -> &Option<bool>

Enforces a minimal level of encryption for the workgroup for query and calculation results that are written to Amazon S3. When enabled, workgroup users can set encryption only to the minimum level set by the administrator or higher when they submit queries. This setting does not apply to Spark-enabled workgroups.

The EnforceWorkGroupConfiguration setting takes precedence over the EnableMinimumEncryptionConfiguration flag. This means that if EnforceWorkGroupConfiguration is true, the EnableMinimumEncryptionConfiguration flag is ignored, and the workgroup configuration for encryption is used.

pub fn query_results_s3_access_grants_configuration( self, input: QueryResultsS3AccessGrantsConfiguration, ) -> Self

Specifies whether Amazon S3 access grants are enabled for query results.

pub fn set_query_results_s3_access_grants_configuration( self, input: Option<QueryResultsS3AccessGrantsConfiguration>, ) -> Self

Specifies whether Amazon S3 access grants are enabled for query results.

pub fn get_query_results_s3_access_grants_configuration( &self, ) -> &Option<QueryResultsS3AccessGrantsConfiguration>

Specifies whether Amazon S3 access grants are enabled for query results.

pub fn monitoring_configuration(self, input: MonitoringConfiguration) -> Self

Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.

pub fn set_monitoring_configuration( self, input: Option<MonitoringConfiguration>, ) -> Self

Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.

pub fn get_monitoring_configuration(&self) -> &Option<MonitoringConfiguration>

Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.

pub fn engine_configuration(self, input: EngineConfiguration) -> Self

The engine configuration for the workgroup, which includes the minimum/maximum number of Data Processing Units (DPU) that queries should use when running in provisioned capacity. If not specified, Athena uses default values (Default value for min is 4 and for max is Minimum of 124 and allocated DPUs).

To specify DPU values for PC queries the WG containing EngineConfiguration should have the following values: The name of the Classifications should be athena-query-engine-properties, with the only allowed properties as max-dpu-count and min-dpu-count.

pub fn set_engine_configuration( self, input: Option<EngineConfiguration>, ) -> Self

The engine configuration for the workgroup, which includes the minimum/maximum number of Data Processing Units (DPU) that queries should use when running in provisioned capacity. If not specified, Athena uses default values (Default value for min is 4 and for max is Minimum of 124 and allocated DPUs).

To specify DPU values for PC queries the WG containing EngineConfiguration should have the following values: The name of the Classifications should be athena-query-engine-properties, with the only allowed properties as max-dpu-count and min-dpu-count.

pub fn get_engine_configuration(&self) -> &Option<EngineConfiguration>

The engine configuration for the workgroup, which includes the minimum/maximum number of Data Processing Units (DPU) that queries should use when running in provisioned capacity. If not specified, Athena uses default values (Default value for min is 4 and for max is Minimum of 124 and allocated DPUs).

To specify DPU values for PC queries the WG containing EngineConfiguration should have the following values: The name of the Classifications should be athena-query-engine-properties, with the only allowed properties as max-dpu-count and min-dpu-count.

pub fn build(self) -> WorkGroupConfigurationUpdates

Consumes the builder and constructs a WorkGroupConfigurationUpdates.

Trait Implementations

impl Clone for WorkGroupConfigurationUpdatesBuilder

fn clone(&self) -> WorkGroupConfigurationUpdatesBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WorkGroupConfigurationUpdatesBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for WorkGroupConfigurationUpdatesBuilder

fn default() -> WorkGroupConfigurationUpdatesBuilder

Returns the “default value” for a type.

impl PartialEq for WorkGroupConfigurationUpdatesBuilder

fn eq(&self, other: &WorkGroupConfigurationUpdatesBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for WorkGroupConfigurationUpdatesBuilder