WorkgroupConfiguration class
Constructors
-
WorkgroupConfiguration({Input<
int?> ? bytesScannedCutoffPerQuery, Input<WorkgroupConfigurationCustomerContentEncryptionConfiguration?> ? customerContentEncryptionConfiguration, Input<bool?> ? enableMinimumEncryptionConfiguration, Input<bool?> ? enforceWorkgroupConfiguration, Input<WorkgroupConfigurationEngineVersion?> ? engineVersion, Input<String?> ? executionRole, Input<WorkgroupConfigurationIdentityCenterConfiguration?> ? identityCenterConfiguration, Input<WorkgroupConfigurationManagedQueryResultsConfiguration?> ? managedQueryResultsConfiguration, Input<WorkgroupConfigurationMonitoringConfiguration?> ? monitoringConfiguration, Input<bool?> ? publishCloudwatchMetricsEnabled, Input<WorkgroupConfigurationQueryResultsS3AccessGrantsConfiguration?> ? queryResultsS3AccessGrantsConfiguration, Input<bool?> ? requesterPaysEnabled, Input<WorkgroupConfigurationResultConfiguration?> ? resultConfiguration}) -
Creates a new WorkgroupConfiguration.
bytesScannedCutoffPerQueryInteger for the upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan. Must be at least10485760.customerContentEncryptionConfigurationConfiguration block to specify the KMS key that is used to encrypt the user's data stores in Athena. This setting applies to the PySpark engine for Athena notebooks. See Customer Content Encryption Configuration below.enableMinimumEncryptionConfigurationBoolean indicating whether a minimum level of encryption is enforced for the workgroup for query and calculation results written to Amazon S3.enforceWorkgroupConfigurationBoolean whether the settings for the workgroup override client-side settings. For more information, see Workgroup Settings Override Client-Side Settings. Defaults totrue.engineVersionConfiguration block for the Athena Engine Versioning. For more information, see Athena Engine Versioning. See Engine Version below.executionRoleRole used to access user resources in notebook sessions and IAM Identity Center enabled workgroups. The property is required for IAM Identity Center enabled workgroups.identityCenterConfigurationConfiguration block to set up an IAM Identity Center enabled workgroup. See Identity Center Configuration below.managedQueryResultsConfigurationConfiguration block for storing results in Athena owned storage. See Managed Query Results Configuration below.monitoringConfigurationConfiguration block for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc. Only applicable to Apache Spark engine. See Monitoring Configuration below.publishCloudwatchMetricsEnabledBoolean whether Amazon CloudWatch metrics are enabled for the workgroup. Defaults totrue.queryResultsS3AccessGrantsConfigurationConfiguration block for S3 access grants. See Query Results S3 Access Grants Configuration below.requesterPaysEnabledIf 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 S3 Developer Guide.resultConfigurationConfiguration block with result settings. See Result Configuration below.const -
WorkgroupConfiguration.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
bytesScannedCutoffPerQuery
→ Input<
int?> ? -
Integer for the upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan. Must be at least
10485760.final -
customerContentEncryptionConfiguration
→ Input<
WorkgroupConfigurationCustomerContentEncryptionConfiguration?> ? -
Configuration block to specify the KMS key that is used to encrypt the user's data stores in Athena. This setting applies to the PySpark engine for Athena notebooks. See Customer Content Encryption Configuration below.
final
-
enableMinimumEncryptionConfiguration
→ Input<
bool?> ? -
Boolean indicating whether a minimum level of encryption is enforced for the workgroup for query and calculation results written to Amazon S3.
final
-
enforceWorkgroupConfiguration
→ Input<
bool?> ? -
Boolean whether the settings for the workgroup override client-side settings. For more information, see Workgroup Settings Override Client-Side Settings. Defaults to
true.final -
engineVersion
→ Input<
WorkgroupConfigurationEngineVersion?> ? -
Configuration block for the Athena Engine Versioning. For more information, see Athena Engine Versioning. See Engine Version below.
final
-
executionRole
→ Input<
String?> ? -
Role used to access user resources in notebook sessions and IAM Identity Center enabled workgroups. The property is required for IAM Identity Center enabled workgroups.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
identityCenterConfiguration
→ Input<
WorkgroupConfigurationIdentityCenterConfiguration?> ? -
Configuration block to set up an IAM Identity Center enabled workgroup. See Identity Center Configuration below.
final
-
managedQueryResultsConfiguration
→ Input<
WorkgroupConfigurationManagedQueryResultsConfiguration?> ? -
Configuration block for storing results in Athena owned storage. See Managed Query Results Configuration below.
final
-
monitoringConfiguration
→ Input<
WorkgroupConfigurationMonitoringConfiguration?> ? -
Configuration block for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc. Only applicable to Apache Spark engine. See Monitoring Configuration below.
final
-
publishCloudwatchMetricsEnabled
→ Input<
bool?> ? -
Boolean whether Amazon CloudWatch metrics are enabled for the workgroup. Defaults to
true.final -
queryResultsS3AccessGrantsConfiguration
→ Input<
WorkgroupConfigurationQueryResultsS3AccessGrantsConfiguration?> ? -
Configuration block for S3 access grants. See Query Results S3 Access Grants Configuration below.
final
-
requesterPaysEnabled
→ Input<
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 S3 Developer Guide.
final
-
resultConfiguration
→ Input<
WorkgroupConfigurationResultConfiguration?> ? -
Configuration block with result settings. See Result Configuration below.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited