#[non_exhaustive]pub struct WorkGroupConfiguration {Show 13 fields
pub result_configuration: Option<ResultConfiguration>,
pub managed_query_results_configuration: Option<ManagedQueryResultsConfiguration>,
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>,
}Expand description
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)§
This struct is marked as non-exhaustive
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.
managed_query_results_configuration: Option<ManagedQueryResultsConfiguration>The configuration for storing results in Athena owned storage, which includes whether this feature is enabled; whether encryption configuration, if any, is used for encrypting query results.
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§
Source§impl WorkGroupConfiguration
impl WorkGroupConfiguration
Sourcepub fn result_configuration(&self) -> Option<&ResultConfiguration>
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.
Sourcepub fn managed_query_results_configuration(
&self,
) -> Option<&ManagedQueryResultsConfiguration>
pub fn managed_query_results_configuration( &self, ) -> Option<&ManagedQueryResultsConfiguration>
The configuration for storing results in Athena owned storage, which includes whether this feature is enabled; whether encryption configuration, if any, is used for encrypting query results.
Sourcepub fn enforce_work_group_configuration(&self) -> Option<bool>
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.
Sourcepub fn publish_cloud_watch_metrics_enabled(&self) -> Option<bool>
pub fn publish_cloud_watch_metrics_enabled(&self) -> Option<bool>
Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
Sourcepub fn bytes_scanned_cutoff_per_query(&self) -> Option<i64>
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.
Sourcepub fn requester_pays_enabled(&self) -> Option<bool>
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.
Sourcepub fn engine_version(&self) -> Option<&EngineVersion>
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.
Sourcepub fn additional_configuration(&self) -> Option<&str>
pub fn additional_configuration(&self) -> Option<&str>
Specifies a user defined JSON string that is passed to the notebook engine.
Sourcepub fn execution_role(&self) -> Option<&str>
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.
Sourcepub fn customer_content_encryption_configuration(
&self,
) -> Option<&CustomerContentEncryptionConfiguration>
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.
Sourcepub fn enable_minimum_encryption_configuration(&self) -> Option<bool>
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.
Sourcepub fn identity_center_configuration(
&self,
) -> Option<&IdentityCenterConfiguration>
pub fn identity_center_configuration( &self, ) -> Option<&IdentityCenterConfiguration>
Specifies whether the workgroup is IAM Identity Center supported.
Sourcepub fn query_results_s3_access_grants_configuration(
&self,
) -> Option<&QueryResultsS3AccessGrantsConfiguration>
pub fn query_results_s3_access_grants_configuration( &self, ) -> Option<&QueryResultsS3AccessGrantsConfiguration>
Specifies whether Amazon S3 access grants are enabled for query results.
Source§impl WorkGroupConfiguration
impl WorkGroupConfiguration
Sourcepub fn builder() -> WorkGroupConfigurationBuilder
pub fn builder() -> WorkGroupConfigurationBuilder
Creates a new builder-style object to manufacture WorkGroupConfiguration.
Trait Implementations§
Source§impl Clone for WorkGroupConfiguration
impl Clone for WorkGroupConfiguration
Source§fn clone(&self) -> WorkGroupConfiguration
fn clone(&self) -> WorkGroupConfiguration
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for WorkGroupConfiguration
impl Debug for WorkGroupConfiguration
Source§impl PartialEq for WorkGroupConfiguration
impl PartialEq for WorkGroupConfiguration
impl StructuralPartialEq for WorkGroupConfiguration
Auto Trait Implementations§
impl Freeze for WorkGroupConfiguration
impl RefUnwindSafe for WorkGroupConfiguration
impl Send for WorkGroupConfiguration
impl Sync for WorkGroupConfiguration
impl Unpin for WorkGroupConfiguration
impl UnwindSafe for WorkGroupConfiguration
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);