Struct aws_sdk_athena::types::WorkGroupConfiguration

#[non_exhaustive]
pub struct WorkGroupConfiguration {
    pub result_configuration: Option<ResultConfiguration>,
    pub enforce_work_group_configuration: Option<bool>,
    pub publish_cloud_watch_metrics_enabled: Option<bool>,
    pub bytes_scanned_cutoff_per_query: Option<i64>,
    pub requester_pays_enabled: Option<bool>,
    pub engine_version: Option<EngineVersion>,
    pub additional_configuration: Option<String>,
    pub execution_role: Option<String>,
    pub customer_content_encryption_configuration: Option<CustomerContentEncryptionConfiguration>,
    pub enable_minimum_encryption_configuration: Option<bool>,
    pub identity_center_configuration: Option<IdentityCenterConfiguration>,
    pub query_results_s3_access_grants_configuration: Option<QueryResultsS3AccessGrantsConfiguration>,
}

The configuration of the workgroup, which includes the location in Amazon S3 where query and calculation results are stored, the encryption option, if any, used for query and calculation results, whether the Amazon CloudWatch Metrics are enabled for the workgroup and whether workgroup settings override query settings, and the data usage limits for the amount of data scanned per query or per workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

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.

result_configuration: Option<ResultConfiguration>

The configuration for the workgroup, which includes the location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation results. To run the query, you must specify the query results location using one of the ways: either in the workgroup using this setting, or for individual queries (client-side), using ResultConfiguration$OutputLocation. If none of them is set, Athena issues an error that no output location is provided. For more information, see Working with query results, recent queries, and output files.

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.

publish_cloud_watch_metrics_enabled: Option<bool>

Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.

bytes_scanned_cutoff_per_query: Option<i64>

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

requester_pays_enabled: Option<bool>

If set to true, allows members assigned to a workgroup to reference 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 that all queries running on the workgroup use. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

additional_configuration: Option<String>

Specifies a user defined JSON string that is passed to the notebook engine.

execution_role: Option<String>

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

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.

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.

identity_center_configuration: Option<IdentityCenterConfiguration>

Specifies whether the workgroup is IAM Identity Center supported.

query_results_s3_access_grants_configuration: Option<QueryResultsS3AccessGrantsConfiguration>

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

Implementations

impl WorkGroupConfiguration

pub fn result_configuration(&self) -> Option<&ResultConfiguration>

The configuration for the workgroup, which includes the location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation results. To run the query, you must specify the query results location using one of the ways: either in the workgroup using this setting, or for individual queries (client-side), using ResultConfiguration$OutputLocation. If none of them is set, Athena issues an error that no output location is provided. For more information, see Working with query results, recent queries, and output files.

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 publish_cloud_watch_metrics_enabled(&self) -> Option<bool>

Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.

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

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

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

If set to true, allows members assigned to a workgroup to reference 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 that all queries running on the workgroup use. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

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

Specifies a user defined JSON string that is passed to the notebook engine.

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

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

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.

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 identity_center_configuration( &self ) -> Option<&IdentityCenterConfiguration>

Specifies whether the workgroup is IAM Identity Center supported.

pub fn query_results_s3_access_grants_configuration( &self ) -> Option<&QueryResultsS3AccessGrantsConfiguration>

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

impl WorkGroupConfiguration

pub fn builder() -> WorkGroupConfigurationBuilder

Creates a new builder-style object to manufacture WorkGroupConfiguration.

Trait Implementations

impl Clone for WorkGroupConfiguration

fn clone(&self) -> WorkGroupConfiguration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WorkGroupConfiguration

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

Formats the value using the given formatter.

impl PartialEq for WorkGroupConfiguration

fn eq(&self, other: &WorkGroupConfiguration) -> 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 WorkGroupConfiguration