#[non_exhaustive]pub struct WorkGroupConfigurationUpdates {Show 14 fields
pub enforce_work_group_configuration: Option<bool>,
pub result_configuration_updates: Option<ResultConfigurationUpdates>,
pub managed_query_results_configuration_updates: Option<ManagedQueryResultsConfigurationUpdates>,
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>,
pub query_results_s3_access_grants_configuration: Option<QueryResultsS3AccessGrantsConfiguration>,
}Expand description
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)§
This struct is marked as non-exhaustive
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.
managed_query_results_configuration_updates: Option<ManagedQueryResultsConfigurationUpdates>Updates configuration information for managed query results in the workgroup.
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>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.
customer_content_encryption_configuration: 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.
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.
query_results_s3_access_grants_configuration: Option<QueryResultsS3AccessGrantsConfiguration>Specifies whether Amazon S3 access grants are enabled for query results.
Implementations§
Source§impl WorkGroupConfigurationUpdates
impl WorkGroupConfigurationUpdates
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 result_configuration_updates(
&self,
) -> Option<&ResultConfigurationUpdates>
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.
Sourcepub fn managed_query_results_configuration_updates(
&self,
) -> Option<&ManagedQueryResultsConfigurationUpdates>
pub fn managed_query_results_configuration_updates( &self, ) -> Option<&ManagedQueryResultsConfigurationUpdates>
Updates configuration information for managed query results in the workgroup.
Sourcepub fn publish_cloud_watch_metrics_enabled(&self) -> Option<bool>
pub fn publish_cloud_watch_metrics_enabled(&self) -> Option<bool>
Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.
Sourcepub fn bytes_scanned_cutoff_per_query(&self) -> Option<i64>
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.
Sourcepub fn remove_bytes_scanned_cutoff_per_query(&self) -> Option<bool>
pub fn remove_bytes_scanned_cutoff_per_query(&self) -> Option<bool>
Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery
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 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.
Sourcepub fn engine_version(&self) -> Option<&EngineVersion>
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.
Sourcepub fn remove_customer_content_encryption_configuration(&self) -> Option<bool>
pub fn remove_customer_content_encryption_configuration(&self) -> Option<bool>
Removes content encryption configuration from an Apache Spark-enabled Athena workgroup.
Sourcepub fn additional_configuration(&self) -> Option<&str>
pub fn additional_configuration(&self) -> Option<&str>
Contains a user defined string in JSON format for a Spark-enabled workgroup.
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 Identity Center enabled workgroups. This property applies only to Spark enabled workgroups and Identity Center enabled workgroups.
Sourcepub fn customer_content_encryption_configuration(
&self,
) -> Option<&CustomerContentEncryptionConfiguration>
pub fn 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.
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. 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.
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 WorkGroupConfigurationUpdates
impl WorkGroupConfigurationUpdates
Sourcepub fn builder() -> WorkGroupConfigurationUpdatesBuilder
pub fn builder() -> WorkGroupConfigurationUpdatesBuilder
Creates a new builder-style object to manufacture WorkGroupConfigurationUpdates.
Trait Implementations§
Source§impl Clone for WorkGroupConfigurationUpdates
impl Clone for WorkGroupConfigurationUpdates
Source§fn clone(&self) -> WorkGroupConfigurationUpdates
fn clone(&self) -> WorkGroupConfigurationUpdates
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl PartialEq for WorkGroupConfigurationUpdates
impl PartialEq for WorkGroupConfigurationUpdates
Source§fn eq(&self, other: &WorkGroupConfigurationUpdates) -> bool
fn eq(&self, other: &WorkGroupConfigurationUpdates) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for WorkGroupConfigurationUpdates
Auto Trait Implementations§
impl Freeze for WorkGroupConfigurationUpdates
impl RefUnwindSafe for WorkGroupConfigurationUpdates
impl Send for WorkGroupConfigurationUpdates
impl Sync for WorkGroupConfigurationUpdates
impl Unpin for WorkGroupConfigurationUpdates
impl UnwindSafe for WorkGroupConfigurationUpdates
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);