Package software.amazon.awscdk.cfnpropertymixins.services.athena

Class CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.athena.CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder

All Implemented Interfaces:

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

Enclosing interface:

CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty

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

A builder for CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder	additionalConfiguration(String additionalConfiguration)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.getAdditionalConfiguration()
CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty	build()	Builds the configured instance.
CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder	bytesScannedCutoffPerQuery(Number bytesScannedCutoffPerQuery)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.getBytesScannedCutoffPerQuery()
CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder	customerContentEncryptionConfiguration(CfnWorkGroupPropsMixin.CustomerContentEncryptionConfigurationProperty customerContentEncryptionConfiguration)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.getCustomerContentEncryptionConfiguration()
CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder	customerContentEncryptionConfiguration(IResolvable customerContentEncryptionConfiguration)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.getCustomerContentEncryptionConfiguration()
CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder	enforceWorkGroupConfiguration(Boolean enforceWorkGroupConfiguration)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.getEnforceWorkGroupConfiguration()
CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder	enforceWorkGroupConfiguration(IResolvable enforceWorkGroupConfiguration)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.getEnforceWorkGroupConfiguration()
CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder	engineConfiguration(CfnWorkGroupPropsMixin.EngineConfigurationProperty engineConfiguration)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.getEngineConfiguration()
CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder	engineConfiguration(IResolvable engineConfiguration)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.getEngineConfiguration()
CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder	engineVersion(CfnWorkGroupPropsMixin.EngineVersionProperty engineVersion)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.getEngineVersion()
CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder	engineVersion(IResolvable engineVersion)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.getEngineVersion()
CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder	executionRole(String executionRole)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.getExecutionRole()
CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder	executionRole(IRoleRef executionRole)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.getExecutionRole()
CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder	managedQueryResultsConfiguration(CfnWorkGroupPropsMixin.ManagedQueryResultsConfigurationProperty managedQueryResultsConfiguration)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.getManagedQueryResultsConfiguration()
CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder	managedQueryResultsConfiguration(IResolvable managedQueryResultsConfiguration)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.getManagedQueryResultsConfiguration()
CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder	monitoringConfiguration(CfnWorkGroupPropsMixin.MonitoringConfigurationProperty monitoringConfiguration)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.getMonitoringConfiguration()
CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder	monitoringConfiguration(IResolvable monitoringConfiguration)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.getMonitoringConfiguration()
CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder	publishCloudWatchMetricsEnabled(Boolean publishCloudWatchMetricsEnabled)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.getPublishCloudWatchMetricsEnabled()
CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder	publishCloudWatchMetricsEnabled(IResolvable publishCloudWatchMetricsEnabled)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.getPublishCloudWatchMetricsEnabled()
CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder	requesterPaysEnabled(Boolean requesterPaysEnabled)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.getRequesterPaysEnabled()
CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder	requesterPaysEnabled(IResolvable requesterPaysEnabled)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.getRequesterPaysEnabled()
CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder	resultConfiguration(CfnWorkGroupPropsMixin.ResultConfigurationProperty resultConfiguration)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.getResultConfiguration()
CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder	resultConfiguration(IResolvable resultConfiguration)	Sets the value of CfnWorkGroupPropsMixin.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 CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder additionalConfiguration(String additionalConfiguration)

Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.getAdditionalConfiguration()

Parameters:

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

Returns:

this

bytesScannedCutoffPerQuery

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

Sets the value of CfnWorkGroupPropsMixin.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 CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder customerContentEncryptionConfiguration(IResolvable customerContentEncryptionConfiguration)

Sets the value of CfnWorkGroupPropsMixin.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 CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder customerContentEncryptionConfiguration(CfnWorkGroupPropsMixin.CustomerContentEncryptionConfigurationProperty customerContentEncryptionConfiguration)

Sets the value of CfnWorkGroupPropsMixin.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 CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder enforceWorkGroupConfiguration(Boolean enforceWorkGroupConfiguration)

Sets the value of CfnWorkGroupPropsMixin.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 Override client-side settings .

Returns:

this

enforceWorkGroupConfiguration

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

Sets the value of CfnWorkGroupPropsMixin.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 Override client-side settings .

Returns:

this

engineConfiguration

@Stability(Stable)
public CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder engineConfiguration(IResolvable engineConfiguration)

Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.getEngineConfiguration()

Parameters:

engineConfiguration - The engine configuration for running queries.

Returns:

this

engineConfiguration

@Stability(Stable)
public CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder engineConfiguration(CfnWorkGroupPropsMixin.EngineConfigurationProperty engineConfiguration)

Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.getEngineConfiguration()

Parameters:

engineConfiguration - The engine configuration for running queries.

Returns:

this

engineVersion

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

Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.getEngineVersion()

Parameters:

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

Returns:

this

engineVersion

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

Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.getEngineVersion()

Parameters:

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

Returns:

this

executionRole

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

Sets the value of CfnWorkGroupPropsMixin.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

executionRole

@Stability(Stable)
public CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder executionRole(IRoleRef executionRole)

Sets the value of CfnWorkGroupPropsMixin.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

managedQueryResultsConfiguration

@Stability(Stable)
public CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder managedQueryResultsConfiguration(IResolvable managedQueryResultsConfiguration)

Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.getManagedQueryResultsConfiguration()

Parameters:

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

this

managedQueryResultsConfiguration

@Stability(Stable)
public CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder managedQueryResultsConfiguration(CfnWorkGroupPropsMixin.ManagedQueryResultsConfigurationProperty managedQueryResultsConfiguration)

Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.getManagedQueryResultsConfiguration()

Parameters:

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

this

monitoringConfiguration

@Stability(Stable)
public CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder monitoringConfiguration(IResolvable monitoringConfiguration)

Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.getMonitoringConfiguration()

Parameters:

monitoringConfiguration - Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.

Returns:

this

monitoringConfiguration

@Stability(Stable)
public CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder monitoringConfiguration(CfnWorkGroupPropsMixin.MonitoringConfigurationProperty monitoringConfiguration)

Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.getMonitoringConfiguration()

Parameters:

monitoringConfiguration - Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.

Returns:

this

publishCloudWatchMetricsEnabled

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

Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.getPublishCloudWatchMetricsEnabled()

Parameters:

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

Returns:

this

publishCloudWatchMetricsEnabled

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

Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.getPublishCloudWatchMetricsEnabled()

Parameters:

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

Returns:

this

requesterPaysEnabled

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

Sets the value of CfnWorkGroupPropsMixin.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 CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder requesterPaysEnabled(IResolvable requesterPaysEnabled)

Sets the value of CfnWorkGroupPropsMixin.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 CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty.Builder resultConfiguration(IResolvable resultConfiguration)

Sets the value of CfnWorkGroupPropsMixin.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 Work with query results and recent queries .

Returns:

this

resultConfiguration

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

Sets the value of CfnWorkGroupPropsMixin.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 Work with query results and recent queries .

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided