Class CfnWorkGroup.WorkGroupConfigurationProperty

The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether Amazon CloudWatch Metrics are enabled for the workgroup, and the limit for the amount of bytes scanned (cutoff) per query, if it is specified.

Inheritance

System.Object

CfnWorkGroup.WorkGroupConfigurationProperty

Implements

CfnWorkGroup.IWorkGroupConfigurationProperty

Namespace: Amazon.CDK.AWS.Athena

Assembly: Amazon.CDK.AWS.Athena.dll

Syntax (csharp)

public class WorkGroupConfigurationProperty : Object, CfnWorkGroup.IWorkGroupConfigurationProperty

Syntax (vb)

Public Class WorkGroupConfigurationProperty
    Inherits Object
    Implements CfnWorkGroup.IWorkGroupConfigurationProperty

Remarks

The EnforceWorkGroupConfiguration option determines whether workgroup settings override client-side query settings.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html

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 workGroupConfigurationProperty = new WorkGroupConfigurationProperty {
    AdditionalConfiguration = "additionalConfiguration",
    BytesScannedCutoffPerQuery = 123,
    CustomerContentEncryptionConfiguration = new CustomerContentEncryptionConfigurationProperty {
        KmsKey = "kmsKey"
    },
    EnforceWorkGroupConfiguration = false,
    EngineVersion = new EngineVersionProperty {
        EffectiveEngineVersion = "effectiveEngineVersion",
        SelectedEngineVersion = "selectedEngineVersion"
    },
    ExecutionRole = "executionRole",
    PublishCloudWatchMetricsEnabled = false,
    RequesterPaysEnabled = false,
    ResultConfiguration = new ResultConfigurationProperty {
        AclConfiguration = new AclConfigurationProperty {
            S3AclOption = "s3AclOption"
        },
        EncryptionConfiguration = new EncryptionConfigurationProperty {
            EncryptionOption = "encryptionOption",

            // the properties below are optional
            KmsKey = "kmsKey"
        },
        ExpectedBucketOwner = "expectedBucketOwner",
        OutputLocation = "outputLocation"
    }
};

Synopsis

Constructors

WorkGroupConfigurationProperty()

Properties

AdditionalConfiguration	Specifies a user defined JSON string that is passed to the session engine.
BytesScannedCutoffPerQuery	The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
CustomerContentEncryptionConfiguration	Specifies the KMS key that is used to encrypt the user's data stores in Athena.
EnforceWorkGroupConfiguration	If set to "true", the settings for the workgroup override client-side settings.
EngineVersion	The engine version that all queries running on the workgroup use.
ExecutionRole	Role used to access user resources in an Athena for Apache Spark session.
PublishCloudWatchMetricsEnabled	Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
RequesterPaysEnabled	If set to true , allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries.
ResultConfiguration	Specifies the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results.

Constructors

WorkGroupConfigurationProperty()

public WorkGroupConfigurationProperty()

Properties

AdditionalConfiguration

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

public string AdditionalConfiguration { get; set; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-additionalconfiguration

BytesScannedCutoffPerQuery

The upper 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

No default is defined.

This property currently supports integer types. Support for long values is planned.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-bytesscannedcutoffperquery

CustomerContentEncryptionConfiguration

Specifies the KMS key that is used to encrypt the user's data stores in Athena.

public object CustomerContentEncryptionConfiguration { get; set; }

Property Value

System.Object

Remarks

This setting does not apply to Athena SQL workgroups.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-customercontentencryptionconfiguration

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. For more information, see Workgroup Settings Override Client-Side Settings .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-enforceworkgroupconfiguration

EngineVersion

The engine version that all queries running on the workgroup use.

public object EngineVersion { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-engineversion

ExecutionRole

Role used to access user resources in an Athena for Apache Spark session.

public string ExecutionRole { get; set; }

Property Value

System.String

Remarks

This property applies only to Spark-enabled workgroups in Athena.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-executionrole

PublishCloudWatchMetricsEnabled

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

public object PublishCloudWatchMetricsEnabled { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-publishcloudwatchmetricsenabled

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. The default is false . For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-requesterpaysenabled

ResultConfiguration

Specifies the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results.

public object ResultConfiguration { get; set; }

Property Value

System.Object

Remarks

For more information, see Working with Query Results, Output Files, and Query History .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-resultconfiguration

Implements

CfnWorkGroup.IWorkGroupConfigurationProperty