Struct aws_sdk_athena::types::WorkGroupConfigurationUpdates

#[non_exhaustive]
pub struct WorkGroupConfigurationUpdates {
    pub enforce_work_group_configuration: Option<bool>,
    pub result_configuration_updates: Option<ResultConfigurationUpdates>,
    pub publish_cloud_watch_metrics_enabled: Option<bool>,
    pub bytes_scanned_cutoff_per_query: Option<i64>,
    pub remove_bytes_scanned_cutoff_per_query: Option<bool>,
    pub requester_pays_enabled: Option<bool>,
    pub engine_version: Option<EngineVersion>,
    pub remove_customer_content_encryption_configuration: Option<bool>,
    pub additional_configuration: Option<String>,
    pub execution_role: Option<String>,
    pub customer_content_encryption_configuration: Option<CustomerContentEncryptionConfiguration>,
    pub enable_minimum_encryption_configuration: Option<bool>,
}

The configuration information that will be updated for this workgroup, which includes the location in Amazon S3 where query and calculation results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, whether the workgroup settings override the client-side settings, and the data usage limit for the amount of bytes scanned per query, if it is specified.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

enforce_work_group_configuration: 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.

result_configuration_updates: 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.

publish_cloud_watch_metrics_enabled: Option<bool>

Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.

bytes_scanned_cutoff_per_query: Option<i64>

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

remove_bytes_scanned_cutoff_per_query: Option<bool>

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

requester_pays_enabled: 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.

engine_version: 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.

remove_customer_content_encryption_configuration: Option<bool>

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

additional_configuration: Option<String>

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

execution_role: Option<String>

Contains the ARN of the execution role for the workgroup

customer_content_encryption_configuration: Option<CustomerContentEncryptionConfiguration>

Specifies the KMS key that is used to encrypt the user's data stores in Athena. This setting does not apply to Athena SQL workgroups.

enable_minimum_encryption_configuration: 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.

Implementations

impl WorkGroupConfigurationUpdates

pub fn 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 ) -> 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 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) -> 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) -> Option<bool>

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

pub fn 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) -> 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) -> Option<bool>

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

pub fn additional_configuration(&self) -> Option<&str>

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

pub fn execution_role(&self) -> Option<&str>

Contains the ARN of the execution role for the workgroup

pub fn customer_content_encryption_configuration( &self ) -> Option<&CustomerContentEncryptionConfiguration>

Specifies the KMS key that is used to encrypt the user's data stores in Athena. This setting does not apply to Athena SQL workgroups.

pub fn 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.

impl WorkGroupConfigurationUpdates

pub fn builder() -> WorkGroupConfigurationUpdatesBuilder

Creates a new builder-style object to manufacture WorkGroupConfigurationUpdates.

Trait Implementations

impl Clone for WorkGroupConfigurationUpdates

fn clone(&self) -> WorkGroupConfigurationUpdates

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WorkGroupConfigurationUpdates

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

Formats the value using the given formatter.

impl PartialEq<WorkGroupConfigurationUpdates> for WorkGroupConfigurationUpdates

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for WorkGroupConfigurationUpdates