Package software.amazon.awscdk.services.athena

Class CfnWorkGroup.WorkGroupConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.services.athena.CfnWorkGroup.WorkGroupConfigurationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnWorkGroup.WorkGroupConfigurationProperty>

Enclosing interface:

CfnWorkGroup.WorkGroupConfigurationProperty

@Stability(Stable)
public static final class CfnWorkGroup.WorkGroupConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnWorkGroup.WorkGroupConfigurationProperty>

A builder for CfnWorkGroup.WorkGroupConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnWorkGroup.WorkGroupConfigurationProperty.Builder	additionalConfiguration(String additionalConfiguration)	Sets the value of CfnWorkGroup.WorkGroupConfigurationProperty.getAdditionalConfiguration()
CfnWorkGroup.WorkGroupConfigurationProperty	build()	Builds the configured instance.
CfnWorkGroup.WorkGroupConfigurationProperty.Builder	bytesScannedCutoffPerQuery(Number bytesScannedCutoffPerQuery)	Sets the value of CfnWorkGroup.WorkGroupConfigurationProperty.getBytesScannedCutoffPerQuery()
CfnWorkGroup.WorkGroupConfigurationProperty.Builder	customerContentEncryptionConfiguration(IResolvable customerContentEncryptionConfiguration)	Sets the value of CfnWorkGroup.WorkGroupConfigurationProperty.getCustomerContentEncryptionConfiguration()
CfnWorkGroup.WorkGroupConfigurationProperty.Builder	customerContentEncryptionConfiguration(CfnWorkGroup.CustomerContentEncryptionConfigurationProperty customerContentEncryptionConfiguration)	Sets the value of CfnWorkGroup.WorkGroupConfigurationProperty.getCustomerContentEncryptionConfiguration()
CfnWorkGroup.WorkGroupConfigurationProperty.Builder	enforceWorkGroupConfiguration(Boolean enforceWorkGroupConfiguration)	Sets the value of CfnWorkGroup.WorkGroupConfigurationProperty.getEnforceWorkGroupConfiguration()
CfnWorkGroup.WorkGroupConfigurationProperty.Builder	enforceWorkGroupConfiguration(IResolvable enforceWorkGroupConfiguration)	Sets the value of CfnWorkGroup.WorkGroupConfigurationProperty.getEnforceWorkGroupConfiguration()
CfnWorkGroup.WorkGroupConfigurationProperty.Builder	engineVersion(IResolvable engineVersion)	Sets the value of CfnWorkGroup.WorkGroupConfigurationProperty.getEngineVersion()
CfnWorkGroup.WorkGroupConfigurationProperty.Builder	engineVersion(CfnWorkGroup.EngineVersionProperty engineVersion)	Sets the value of CfnWorkGroup.WorkGroupConfigurationProperty.getEngineVersion()
CfnWorkGroup.WorkGroupConfigurationProperty.Builder	executionRole(String executionRole)	Sets the value of CfnWorkGroup.WorkGroupConfigurationProperty.getExecutionRole()
CfnWorkGroup.WorkGroupConfigurationProperty.Builder	publishCloudWatchMetricsEnabled(Boolean publishCloudWatchMetricsEnabled)	Sets the value of CfnWorkGroup.WorkGroupConfigurationProperty.getPublishCloudWatchMetricsEnabled()
CfnWorkGroup.WorkGroupConfigurationProperty.Builder	publishCloudWatchMetricsEnabled(IResolvable publishCloudWatchMetricsEnabled)	Sets the value of CfnWorkGroup.WorkGroupConfigurationProperty.getPublishCloudWatchMetricsEnabled()
CfnWorkGroup.WorkGroupConfigurationProperty.Builder	requesterPaysEnabled(Boolean requesterPaysEnabled)	Sets the value of CfnWorkGroup.WorkGroupConfigurationProperty.getRequesterPaysEnabled()
CfnWorkGroup.WorkGroupConfigurationProperty.Builder	requesterPaysEnabled(IResolvable requesterPaysEnabled)	Sets the value of CfnWorkGroup.WorkGroupConfigurationProperty.getRequesterPaysEnabled()
CfnWorkGroup.WorkGroupConfigurationProperty.Builder	resultConfiguration(IResolvable resultConfiguration)	Sets the value of CfnWorkGroup.WorkGroupConfigurationProperty.getResultConfiguration()
CfnWorkGroup.WorkGroupConfigurationProperty.Builder	resultConfiguration(CfnWorkGroup.ResultConfigurationProperty resultConfiguration)	Sets the value of CfnWorkGroup.WorkGroupConfigurationProperty.getResultConfiguration()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

additionalConfiguration

@Stability(Stable)
public CfnWorkGroup.WorkGroupConfigurationProperty.Builder additionalConfiguration(String additionalConfiguration)

Sets the value of CfnWorkGroup.WorkGroupConfigurationProperty.getAdditionalConfiguration()

Parameters:

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

Returns:

this

bytesScannedCutoffPerQuery

@Stability(Stable)
public CfnWorkGroup.WorkGroupConfigurationProperty.Builder bytesScannedCutoffPerQuery(Number bytesScannedCutoffPerQuery)

Sets the value of CfnWorkGroup.WorkGroupConfigurationProperty.getBytesScannedCutoffPerQuery()

Parameters:

bytesScannedCutoffPerQuery - 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.

Returns:

this

customerContentEncryptionConfiguration

@Stability(Stable)
public CfnWorkGroup.WorkGroupConfigurationProperty.Builder customerContentEncryptionConfiguration(IResolvable customerContentEncryptionConfiguration)

Sets the value of CfnWorkGroup.WorkGroupConfigurationProperty.getCustomerContentEncryptionConfiguration()

Parameters:

customerContentEncryptionConfiguration - 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:

this

customerContentEncryptionConfiguration

@Stability(Stable)
public CfnWorkGroup.WorkGroupConfigurationProperty.Builder customerContentEncryptionConfiguration(CfnWorkGroup.CustomerContentEncryptionConfigurationProperty customerContentEncryptionConfiguration)

Sets the value of CfnWorkGroup.WorkGroupConfigurationProperty.getCustomerContentEncryptionConfiguration()

Parameters:

customerContentEncryptionConfiguration - 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:

this

enforceWorkGroupConfiguration

@Stability(Stable)
public CfnWorkGroup.WorkGroupConfigurationProperty.Builder enforceWorkGroupConfiguration(Boolean enforceWorkGroupConfiguration)

Sets the value of CfnWorkGroup.WorkGroupConfigurationProperty.getEnforceWorkGroupConfiguration()

Parameters:

enforceWorkGroupConfiguration - 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 Workgroup Settings Override Client-Side Settings .

Returns:

this

enforceWorkGroupConfiguration

@Stability(Stable)
public CfnWorkGroup.WorkGroupConfigurationProperty.Builder enforceWorkGroupConfiguration(IResolvable enforceWorkGroupConfiguration)

Sets the value of CfnWorkGroup.WorkGroupConfigurationProperty.getEnforceWorkGroupConfiguration()

Parameters:

enforceWorkGroupConfiguration - 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 Workgroup Settings Override Client-Side Settings .

Returns:

this

engineVersion

@Stability(Stable)
public CfnWorkGroup.WorkGroupConfigurationProperty.Builder engineVersion(IResolvable engineVersion)

Sets the value of CfnWorkGroup.WorkGroupConfigurationProperty.getEngineVersion()

Parameters:

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

Returns:

this

engineVersion

@Stability(Stable)
public CfnWorkGroup.WorkGroupConfigurationProperty.Builder engineVersion(CfnWorkGroup.EngineVersionProperty engineVersion)

Sets the value of CfnWorkGroup.WorkGroupConfigurationProperty.getEngineVersion()

Parameters:

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

Returns:

this

executionRole

@Stability(Stable)
public CfnWorkGroup.WorkGroupConfigurationProperty.Builder executionRole(String executionRole)

Sets the value of CfnWorkGroup.WorkGroupConfigurationProperty.getExecutionRole()

Parameters:

executionRole - Role used to access user resources in an Athena for Apache Spark session. This property applies only to Spark-enabled workgroups in Athena.

Returns:

this

publishCloudWatchMetricsEnabled

@Stability(Stable)
public CfnWorkGroup.WorkGroupConfigurationProperty.Builder publishCloudWatchMetricsEnabled(Boolean publishCloudWatchMetricsEnabled)

Sets the value of CfnWorkGroup.WorkGroupConfigurationProperty.getPublishCloudWatchMetricsEnabled()

Parameters:

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

Returns:

this

publishCloudWatchMetricsEnabled

@Stability(Stable)
public CfnWorkGroup.WorkGroupConfigurationProperty.Builder publishCloudWatchMetricsEnabled(IResolvable publishCloudWatchMetricsEnabled)

Sets the value of CfnWorkGroup.WorkGroupConfigurationProperty.getPublishCloudWatchMetricsEnabled()

Parameters:

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

Returns:

this

requesterPaysEnabled

@Stability(Stable)
public CfnWorkGroup.WorkGroupConfigurationProperty.Builder requesterPaysEnabled(Boolean requesterPaysEnabled)

Sets the value of CfnWorkGroup.WorkGroupConfigurationProperty.getRequesterPaysEnabled()

Parameters:

requesterPaysEnabled - 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:

this

requesterPaysEnabled

@Stability(Stable)
public CfnWorkGroup.WorkGroupConfigurationProperty.Builder requesterPaysEnabled(IResolvable requesterPaysEnabled)

Sets the value of CfnWorkGroup.WorkGroupConfigurationProperty.getRequesterPaysEnabled()

Parameters:

requesterPaysEnabled - 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:

this

resultConfiguration

@Stability(Stable)
public CfnWorkGroup.WorkGroupConfigurationProperty.Builder resultConfiguration(IResolvable resultConfiguration)

Sets the value of CfnWorkGroup.WorkGroupConfigurationProperty.getResultConfiguration()

Parameters:

resultConfiguration - 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 Working with Query Results, Output Files, and Query History .

Returns:

this

resultConfiguration

@Stability(Stable)
public CfnWorkGroup.WorkGroupConfigurationProperty.Builder resultConfiguration(CfnWorkGroup.ResultConfigurationProperty resultConfiguration)

Sets the value of CfnWorkGroup.WorkGroupConfigurationProperty.getResultConfiguration()

Parameters:

resultConfiguration - 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 Working with Query Results, Output Files, and Query History .

Returns:

this

build

@Stability(Stable)
public CfnWorkGroup.WorkGroupConfigurationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnWorkGroup.WorkGroupConfigurationProperty>

Returns:

a new instance of CfnWorkGroup.WorkGroupConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided