Package software.amazon.awscdk.services.athena

Class CfnWorkGroup.WorkGroupConfigurationProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.athena.CfnWorkGroup.WorkGroupConfigurationProperty.Jsii$Proxy

All Implemented Interfaces:

CfnWorkGroup.WorkGroupConfigurationProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnWorkGroup.WorkGroupConfigurationProperty

@Stability(Stable)
@Internal
public static final class CfnWorkGroup.WorkGroupConfigurationProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnWorkGroup.WorkGroupConfigurationProperty

An implementation for CfnWorkGroup.WorkGroupConfigurationProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.athena.CfnWorkGroup.WorkGroupConfigurationProperty

CfnWorkGroup.WorkGroupConfigurationProperty.Builder, CfnWorkGroup.WorkGroupConfigurationProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnWorkGroup.WorkGroupConfigurationProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnWorkGroup.WorkGroupConfigurationProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getAdditionalConfiguration()	Specifies a user defined JSON string that is passed to the session engine.
final Number	getBytesScannedCutoffPerQuery()	The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
final Object	getCustomerContentEncryptionConfiguration()	Specifies the KMS key that is used to encrypt the user's data stores in Athena.
final Object	getEnforceWorkGroupConfiguration()	If set to "true", the settings for the workgroup override client-side settings.
final Object	getEngineVersion()	The engine version that all queries running on the workgroup use.
final String	getExecutionRole()	Role used to access user resources in an Athena for Apache Spark session.
final Object	getManagedQueryResultsConfiguration()	The configuration for storing results in Athena owned storage, which includes whether this feature is enabled;
final Object	getPublishCloudWatchMetricsEnabled()	Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
final Object	getRequesterPaysEnabled()	If set to true , allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries.
final Object	getResultConfiguration()	Specifies the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnWorkGroup.WorkGroupConfigurationProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnWorkGroup.WorkGroupConfigurationProperty.Builder.

Method Details

getAdditionalConfiguration

public final String getAdditionalConfiguration()

Description copied from interface: CfnWorkGroup.WorkGroupConfigurationProperty

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

Specified by:

getAdditionalConfiguration in interface CfnWorkGroup.WorkGroupConfigurationProperty

See Also:

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

getBytesScannedCutoffPerQuery

public final Number getBytesScannedCutoffPerQuery()

Description copied from interface: CfnWorkGroup.WorkGroupConfigurationProperty

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

No default is defined.

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

Specified by:

getBytesScannedCutoffPerQuery in interface CfnWorkGroup.WorkGroupConfigurationProperty

See Also:

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

getCustomerContentEncryptionConfiguration

public final Object getCustomerContentEncryptionConfiguration()

Description copied from interface: CfnWorkGroup.WorkGroupConfigurationProperty

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

This setting does not apply to Athena SQL workgroups.

Returns union: either IResolvable or CfnWorkGroup.CustomerContentEncryptionConfigurationProperty

Specified by:

getCustomerContentEncryptionConfiguration in interface CfnWorkGroup.WorkGroupConfigurationProperty

See Also:

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

getEnforceWorkGroupConfiguration

public final Object getEnforceWorkGroupConfiguration()

Description copied from interface: CfnWorkGroup.WorkGroupConfigurationProperty

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 Override client-side settings .

Returns union: either Boolean or IResolvable

Specified by:

getEnforceWorkGroupConfiguration in interface CfnWorkGroup.WorkGroupConfigurationProperty

See Also:

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

getEngineVersion

public final Object getEngineVersion()

Description copied from interface: CfnWorkGroup.WorkGroupConfigurationProperty

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

Returns union: either IResolvable or CfnWorkGroup.EngineVersionProperty

Specified by:

getEngineVersion in interface CfnWorkGroup.WorkGroupConfigurationProperty

See Also:

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

getExecutionRole

public final String getExecutionRole()

Description copied from interface: CfnWorkGroup.WorkGroupConfigurationProperty

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

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

Specified by:

getExecutionRole in interface CfnWorkGroup.WorkGroupConfigurationProperty

See Also:

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

getManagedQueryResultsConfiguration

public final Object getManagedQueryResultsConfiguration()

Description copied from interface: CfnWorkGroup.WorkGroupConfigurationProperty

The configuration for storing results in Athena owned storage, which includes whether this feature is enabled;

whether encryption configuration, if any, is used for encrypting query results.

Returns union: either IResolvable or CfnWorkGroup.ManagedQueryResultsConfigurationProperty

Specified by:

getManagedQueryResultsConfiguration in interface CfnWorkGroup.WorkGroupConfigurationProperty

See Also:

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

getPublishCloudWatchMetricsEnabled

public final Object getPublishCloudWatchMetricsEnabled()

Description copied from interface: CfnWorkGroup.WorkGroupConfigurationProperty

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

Returns union: either Boolean or IResolvable

Specified by:

getPublishCloudWatchMetricsEnabled in interface CfnWorkGroup.WorkGroupConfigurationProperty

See Also:

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

getRequesterPaysEnabled

public final Object getRequesterPaysEnabled()

Description copied from interface: CfnWorkGroup.WorkGroupConfigurationProperty

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 Amazon Simple Storage Service Developer Guide .

Returns union: either Boolean or IResolvable

Specified by:

getRequesterPaysEnabled in interface CfnWorkGroup.WorkGroupConfigurationProperty

See Also:

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

getResultConfiguration

public final Object getResultConfiguration()

Description copied from interface: CfnWorkGroup.WorkGroupConfigurationProperty

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

For more information, see Work with query results and recent queries .

Returns union: either IResolvable or CfnWorkGroup.ResultConfigurationProperty

Specified by:

getResultConfiguration in interface CfnWorkGroup.WorkGroupConfigurationProperty

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object