Package software.amazon.awscdk.services.athena

Interface CfnWorkGroup.WorkGroupConfigurationUpdatesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWorkGroup.WorkGroupConfigurationUpdatesProperty.Jsii$Proxy

Enclosing class:

CfnWorkGroup

@Stability(Stable)
public static interface CfnWorkGroup.WorkGroupConfigurationUpdatesProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.athena.*;
 WorkGroupConfigurationUpdatesProperty workGroupConfigurationUpdatesProperty = WorkGroupConfigurationUpdatesProperty.builder()
         .additionalConfiguration("additionalConfiguration")
         .bytesScannedCutoffPerQuery(123)
         .customerContentEncryptionConfiguration(CustomerContentEncryptionConfigurationProperty.builder()
                 .kmsKey("kmsKey")
                 .build())
         .enforceWorkGroupConfiguration(false)
         .engineVersion(EngineVersionProperty.builder()
                 .effectiveEngineVersion("effectiveEngineVersion")
                 .selectedEngineVersion("selectedEngineVersion")
                 .build())
         .executionRole("executionRole")
         .managedQueryResultsConfiguration(ManagedQueryResultsConfigurationProperty.builder()
                 .enabled(false)
                 .encryptionConfiguration(ManagedStorageEncryptionConfigurationProperty.builder()
                         .kmsKey("kmsKey")
                         .build())
                 .build())
         .publishCloudWatchMetricsEnabled(false)
         .removeBytesScannedCutoffPerQuery(false)
         .removeCustomerContentEncryptionConfiguration(false)
         .requesterPaysEnabled(false)
         .resultConfigurationUpdates(ResultConfigurationUpdatesProperty.builder()
                 .aclConfiguration(AclConfigurationProperty.builder()
                         .s3AclOption("s3AclOption")
                         .build())
                 .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                         .encryptionOption("encryptionOption")
                         // the properties below are optional
                         .kmsKey("kmsKey")
                         .build())
                 .expectedBucketOwner("expectedBucketOwner")
                 .outputLocation("outputLocation")
                 .removeAclConfiguration(false)
                 .removeEncryptionConfiguration(false)
                 .removeExpectedBucketOwner(false)
                 .removeOutputLocation(false)
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnWorkGroup.WorkGroupConfigurationUpdatesProperty.Builder	A builder for CfnWorkGroup.WorkGroupConfigurationUpdatesProperty
static final class	CfnWorkGroup.WorkGroupConfigurationUpdatesProperty.Jsii$Proxy	An implementation for CfnWorkGroup.WorkGroupConfigurationUpdatesProperty

Method Summary

Modifier and Type	Method	Description
static CfnWorkGroup.WorkGroupConfigurationUpdatesProperty.Builder	builder()
default String	getAdditionalConfiguration()	Additional Configuration that are passed to Athena Spark Calculations running in this workgroup.
default Number	getBytesScannedCutoffPerQuery()	The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
default Object	getCustomerContentEncryptionConfiguration()	Indicates the KMS key for encrypting notebook content.
default Object	getEnforceWorkGroupConfiguration()	If set to "true", the settings for the workgroup override client-side settings.
default Object	getEngineVersion()	The Athena engine version for running queries.
default String	getExecutionRole()	Execution Role ARN required to run Athena Spark Calculations.
default Object	getManagedQueryResultsConfiguration()	The configuration for the managed query results and encryption option.
default Object	getPublishCloudWatchMetricsEnabled()	Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
default Object	getRemoveBytesScannedCutoffPerQuery()	Indicates that the data usage control limit per query is removed.
default Object	getRemoveCustomerContentEncryptionConfiguration()	Returns union: either Boolean or IResolvable
default Object	getRequesterPaysEnabled()	If set to true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries.
default Object	getResultConfigurationUpdates()	The result configuration information about the queries in this workgroup that will be updated.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAdditionalConfiguration

@Stability(Stable)
@Nullable
default String getAdditionalConfiguration()

Additional Configuration that are passed to Athena Spark Calculations running in this workgroup.

See Also:

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

getBytesScannedCutoffPerQuery

@Stability(Stable)
@Nullable
default Number getBytesScannedCutoffPerQuery()

The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.

See Also:

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

getCustomerContentEncryptionConfiguration

@Stability(Stable)
@Nullable
default Object getCustomerContentEncryptionConfiguration()

Indicates the KMS key for encrypting notebook content.

Returns union: either IResolvable or CfnWorkGroup.CustomerContentEncryptionConfigurationProperty

See Also:

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

getEnforceWorkGroupConfiguration

@Stability(Stable)
@Nullable
default Object getEnforceWorkGroupConfiguration()

If set to "true", the settings for the workgroup override client-side settings.

If set to "false", client-side settings are used

Returns union: either Boolean or IResolvable

See Also:

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

getEngineVersion

@Stability(Stable)
@Nullable
default Object getEngineVersion()

The Athena engine version for running queries.

Returns union: either IResolvable or CfnWorkGroup.EngineVersionProperty

See Also:

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

getExecutionRole

@Stability(Stable)
@Nullable
default String getExecutionRole()

Execution Role ARN required to run Athena Spark Calculations.

See Also:

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

getManagedQueryResultsConfiguration

@Stability(Stable)
@Nullable
default Object getManagedQueryResultsConfiguration()

The configuration for the managed query results and encryption option.

ResultConfiguration and ManagedQueryResultsConfiguration cannot be set at the same time

Returns union: either IResolvable or CfnWorkGroup.ManagedQueryResultsConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfigurationupdates.html#cfn-athena-workgroup-workgroupconfigurationupdates-managedqueryresultsconfiguration

getPublishCloudWatchMetricsEnabled

@Stability(Stable)
@Nullable
default Object getPublishCloudWatchMetricsEnabled()

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

Returns union: either Boolean or IResolvable

See Also:

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

getRemoveBytesScannedCutoffPerQuery

@Stability(Stable)
@Nullable
default Object getRemoveBytesScannedCutoffPerQuery()

Indicates that the data usage control limit per query is removed.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfigurationupdates.html#cfn-athena-workgroup-workgroupconfigurationupdates-removebytesscannedcutoffperquery

getRemoveCustomerContentEncryptionConfiguration

@Stability(Stable)
@Nullable
default Object getRemoveCustomerContentEncryptionConfiguration()

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfigurationupdates.html#cfn-athena-workgroup-workgroupconfigurationupdates-removecustomercontentencryptionconfiguration

getRequesterPaysEnabled

@Stability(Stable)
@Nullable
default Object getRequesterPaysEnabled()

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.

Returns union: either Boolean or IResolvable

See Also:

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

getResultConfigurationUpdates

@Stability(Stable)
@Nullable
default Object getResultConfigurationUpdates()

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.

Returns union: either IResolvable or CfnWorkGroup.ResultConfigurationUpdatesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfigurationupdates.html#cfn-athena-workgroup-workgroupconfigurationupdates-resultconfigurationupdates

builder

@Stability(Stable)
static CfnWorkGroup.WorkGroupConfigurationUpdatesProperty.Builder builder()

Returns:

a CfnWorkGroup.WorkGroupConfigurationUpdatesProperty.Builder of CfnWorkGroup.WorkGroupConfigurationUpdatesProperty