Class CfnWorkGroup.WorkGroupConfigurationUpdatesProperty
The configuration information that will be updated for this workgroup, which includes the location in Amazon S3 where query 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.
Inheritance
Namespace: Amazon.CDK.AWS.Athena
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class WorkGroupConfigurationUpdatesProperty : Object, CfnWorkGroup.IWorkGroupConfigurationUpdatesProperty
Syntax (vb)
Public Class WorkGroupConfigurationUpdatesProperty
Inherits Object
Implements CfnWorkGroup.IWorkGroupConfigurationUpdatesProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Athena;
var workGroupConfigurationUpdatesProperty = new WorkGroupConfigurationUpdatesProperty {
AdditionalConfiguration = "additionalConfiguration",
BytesScannedCutoffPerQuery = 123,
CustomerContentEncryptionConfiguration = new CustomerContentEncryptionConfigurationProperty {
KmsKey = "kmsKey"
},
EnforceWorkGroupConfiguration = false,
EngineVersion = new EngineVersionProperty {
EffectiveEngineVersion = "effectiveEngineVersion",
SelectedEngineVersion = "selectedEngineVersion"
},
ExecutionRole = "executionRole",
PublishCloudWatchMetricsEnabled = false,
RemoveBytesScannedCutoffPerQuery = false,
RemoveCustomerContentEncryptionConfiguration = false,
RequesterPaysEnabled = false,
ResultConfigurationUpdates = new ResultConfigurationUpdatesProperty {
AclConfiguration = new AclConfigurationProperty {
S3AclOption = "s3AclOption"
},
EncryptionConfiguration = new EncryptionConfigurationProperty {
EncryptionOption = "encryptionOption",
// the properties below are optional
KmsKey = "kmsKey"
},
ExpectedBucketOwner = "expectedBucketOwner",
OutputLocation = "outputLocation",
RemoveAclConfiguration = false,
RemoveEncryptionConfiguration = false,
RemoveExpectedBucketOwner = false,
RemoveOutputLocation = false
}
};
Synopsis
Constructors
WorkGroupConfigurationUpdatesProperty() |
Properties
AdditionalConfiguration | Additional Configuration that are passed to Athena Spark Calculations running in this workgroup. |
BytesScannedCutoffPerQuery | The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan. |
CustomerContentEncryptionConfiguration | Indicates the KMS key for encrypting notebook content. |
EnforceWorkGroupConfiguration | If set to "true", the settings for the workgroup override client-side settings. |
EngineVersion | The Athena engine version for running queries. |
ExecutionRole | Execution Role ARN required to run Athena Spark Calculations. |
PublishCloudWatchMetricsEnabled | Indicates that the Amazon CloudWatch metrics are enabled for the workgroup. |
RemoveBytesScannedCutoffPerQuery | Indicates that the data usage control limit per query is removed. |
RemoveCustomerContentEncryptionConfiguration | |
RequesterPaysEnabled | If set to true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. |
ResultConfigurationUpdates | The result configuration information about the queries in this workgroup that will be updated. |
Constructors
WorkGroupConfigurationUpdatesProperty()
public WorkGroupConfigurationUpdatesProperty()
Properties
AdditionalConfiguration
Additional Configuration that are passed to Athena Spark Calculations running in this workgroup.
public string AdditionalConfiguration { get; set; }
Property Value
System.String
Remarks
BytesScannedCutoffPerQuery
The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
public Nullable<double> BytesScannedCutoffPerQuery { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
CustomerContentEncryptionConfiguration
Indicates the KMS key for encrypting notebook content.
public object CustomerContentEncryptionConfiguration { get; set; }
Property Value
System.Object
Remarks
EnforceWorkGroupConfiguration
If set to "true", the settings for the workgroup override client-side settings.
public object EnforceWorkGroupConfiguration { get; set; }
Property Value
System.Object
Remarks
If set to "false", client-side settings are used
EngineVersion
The Athena engine version for running queries.
public object EngineVersion { get; set; }
Property Value
System.Object
Remarks
ExecutionRole
Execution Role ARN required to run Athena Spark Calculations.
public string ExecutionRole { get; set; }
Property Value
System.String
Remarks
PublishCloudWatchMetricsEnabled
Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
public object PublishCloudWatchMetricsEnabled { get; set; }
Property Value
System.Object
Remarks
RemoveBytesScannedCutoffPerQuery
Indicates that the data usage control limit per query is removed.
public object RemoveBytesScannedCutoffPerQuery { get; set; }
Property Value
System.Object
Remarks
RemoveCustomerContentEncryptionConfiguration
public object RemoveCustomerContentEncryptionConfiguration { get; set; }
Property Value
System.Object
Remarks
RequesterPaysEnabled
If set to true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries.
public object RequesterPaysEnabled { get; set; }
Property Value
System.Object
Remarks
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.
ResultConfigurationUpdates
The result configuration information about the queries in this workgroup that will be updated.
public object ResultConfigurationUpdates { get; set; }
Property Value
System.Object
Remarks
Includes the updated results location and an updated option for encrypting query results.