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

Class CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder

java.lang.Object

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

All Implemented Interfaces:

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

Enclosing interface:

CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty

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

A builder for CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder	additionalConfiguration(String additionalConfiguration)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getAdditionalConfiguration()
CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty	build()	Builds the configured instance.
CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder	bytesScannedCutoffPerQuery(Number bytesScannedCutoffPerQuery)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getBytesScannedCutoffPerQuery()
CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder	customerContentEncryptionConfiguration(CfnWorkGroupPropsMixin.CustomerContentEncryptionConfigurationProperty customerContentEncryptionConfiguration)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getCustomerContentEncryptionConfiguration()
CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder	customerContentEncryptionConfiguration(IResolvable customerContentEncryptionConfiguration)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getCustomerContentEncryptionConfiguration()
CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder	enforceWorkGroupConfiguration(Boolean enforceWorkGroupConfiguration)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getEnforceWorkGroupConfiguration()
CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder	enforceWorkGroupConfiguration(IResolvable enforceWorkGroupConfiguration)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getEnforceWorkGroupConfiguration()
CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder	engineConfiguration(CfnWorkGroupPropsMixin.EngineConfigurationProperty engineConfiguration)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getEngineConfiguration()
CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder	engineConfiguration(IResolvable engineConfiguration)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getEngineConfiguration()
CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder	engineVersion(CfnWorkGroupPropsMixin.EngineVersionProperty engineVersion)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getEngineVersion()
CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder	engineVersion(IResolvable engineVersion)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getEngineVersion()
CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder	executionRole(String executionRole)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getExecutionRole()
CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder	executionRole(IRoleRef executionRole)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getExecutionRole()
CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder	managedQueryResultsConfiguration(CfnWorkGroupPropsMixin.ManagedQueryResultsConfigurationProperty managedQueryResultsConfiguration)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getManagedQueryResultsConfiguration()
CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder	managedQueryResultsConfiguration(IResolvable managedQueryResultsConfiguration)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getManagedQueryResultsConfiguration()
CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder	monitoringConfiguration(CfnWorkGroupPropsMixin.MonitoringConfigurationProperty monitoringConfiguration)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getMonitoringConfiguration()
CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder	monitoringConfiguration(IResolvable monitoringConfiguration)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getMonitoringConfiguration()
CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder	publishCloudWatchMetricsEnabled(Boolean publishCloudWatchMetricsEnabled)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getPublishCloudWatchMetricsEnabled()
CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder	publishCloudWatchMetricsEnabled(IResolvable publishCloudWatchMetricsEnabled)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getPublishCloudWatchMetricsEnabled()
CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder	removeBytesScannedCutoffPerQuery(Boolean removeBytesScannedCutoffPerQuery)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getRemoveBytesScannedCutoffPerQuery()
CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder	removeBytesScannedCutoffPerQuery(IResolvable removeBytesScannedCutoffPerQuery)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getRemoveBytesScannedCutoffPerQuery()
CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder	removeCustomerContentEncryptionConfiguration(Boolean removeCustomerContentEncryptionConfiguration)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getRemoveCustomerContentEncryptionConfiguration()
CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder	removeCustomerContentEncryptionConfiguration(IResolvable removeCustomerContentEncryptionConfiguration)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getRemoveCustomerContentEncryptionConfiguration()
CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder	requesterPaysEnabled(Boolean requesterPaysEnabled)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getRequesterPaysEnabled()
CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder	requesterPaysEnabled(IResolvable requesterPaysEnabled)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getRequesterPaysEnabled()
CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder	resultConfigurationUpdates(CfnWorkGroupPropsMixin.ResultConfigurationUpdatesProperty resultConfigurationUpdates)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getResultConfigurationUpdates()
CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder	resultConfigurationUpdates(IResolvable resultConfigurationUpdates)	Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getResultConfigurationUpdates()

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.WorkGroupConfigurationUpdatesProperty.Builder additionalConfiguration(String additionalConfiguration)

Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getAdditionalConfiguration()

Parameters:

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

Returns:

this

bytesScannedCutoffPerQuery

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

Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getBytesScannedCutoffPerQuery()

Parameters:

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

Returns:

this

customerContentEncryptionConfiguration

@Stability(Stable)
public CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder customerContentEncryptionConfiguration(IResolvable customerContentEncryptionConfiguration)

Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getCustomerContentEncryptionConfiguration()

Parameters:

customerContentEncryptionConfiguration - Indicates the KMS key for encrypting notebook content.

Returns:

this

customerContentEncryptionConfiguration

@Stability(Stable)
public CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder customerContentEncryptionConfiguration(CfnWorkGroupPropsMixin.CustomerContentEncryptionConfigurationProperty customerContentEncryptionConfiguration)

Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getCustomerContentEncryptionConfiguration()

Parameters:

customerContentEncryptionConfiguration - Indicates the KMS key for encrypting notebook content.

Returns:

this

enforceWorkGroupConfiguration

@Stability(Stable)
public CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder enforceWorkGroupConfiguration(Boolean enforceWorkGroupConfiguration)

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

Returns:

this

enforceWorkGroupConfiguration

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

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

Returns:

this

engineConfiguration

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

Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getEngineConfiguration()

Parameters:

engineConfiguration - The engine configuration for running queries.

Returns:

this

engineConfiguration

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

Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getEngineConfiguration()

Parameters:

engineConfiguration - The engine configuration for running queries.

Returns:

this

engineVersion

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

Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getEngineVersion()

Parameters:

engineVersion - The Athena engine version for running queries.

Returns:

this

engineVersion

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

Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getEngineVersion()

Parameters:

engineVersion - The Athena engine version for running queries.

Returns:

this

executionRole

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

Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getExecutionRole()

Parameters:

executionRole - The ARN of the execution role used to access user resources for Spark sessions and Identity Center enabled workgroups. This property applies only to Spark enabled workgroups and Identity Center enabled workgroups.

Returns:

this

executionRole

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

Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getExecutionRole()

Parameters:

executionRole - The ARN of the execution role used to access user resources for Spark sessions and Identity Center enabled workgroups. This property applies only to Spark enabled workgroups and Identity Center enabled workgroups.

Returns:

this

managedQueryResultsConfiguration

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

Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getManagedQueryResultsConfiguration()

Parameters:

managedQueryResultsConfiguration - The configuration for the managed query results and encryption option. ResultConfiguration and ManagedQueryResultsConfiguration cannot be set at the same time

Returns:

this

managedQueryResultsConfiguration

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

Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getManagedQueryResultsConfiguration()

Parameters:

managedQueryResultsConfiguration - The configuration for the managed query results and encryption option. ResultConfiguration and ManagedQueryResultsConfiguration cannot be set at the same time

Returns:

this

monitoringConfiguration

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

Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.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.WorkGroupConfigurationUpdatesProperty.Builder monitoringConfiguration(CfnWorkGroupPropsMixin.MonitoringConfigurationProperty monitoringConfiguration)

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

Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getPublishCloudWatchMetricsEnabled()

Parameters:

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

Returns:

this

publishCloudWatchMetricsEnabled

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

Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getPublishCloudWatchMetricsEnabled()

Parameters:

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

Returns:

this

removeBytesScannedCutoffPerQuery

@Stability(Stable)
public CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder removeBytesScannedCutoffPerQuery(Boolean removeBytesScannedCutoffPerQuery)

Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getRemoveBytesScannedCutoffPerQuery()

Parameters:

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

Returns:

this

removeBytesScannedCutoffPerQuery

@Stability(Stable)
public CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder removeBytesScannedCutoffPerQuery(IResolvable removeBytesScannedCutoffPerQuery)

Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getRemoveBytesScannedCutoffPerQuery()

Parameters:

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

Returns:

this

removeCustomerContentEncryptionConfiguration

@Stability(Stable)
public CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder removeCustomerContentEncryptionConfiguration(Boolean removeCustomerContentEncryptionConfiguration)

Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getRemoveCustomerContentEncryptionConfiguration()

Parameters:

removeCustomerContentEncryptionConfiguration - the value to be set.

Returns:

this

removeCustomerContentEncryptionConfiguration

@Stability(Stable)
public CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder removeCustomerContentEncryptionConfiguration(IResolvable removeCustomerContentEncryptionConfiguration)

Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getRemoveCustomerContentEncryptionConfiguration()

Parameters:

removeCustomerContentEncryptionConfiguration - the value to be set.

Returns:

this

requesterPaysEnabled

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

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

Returns:

this

requesterPaysEnabled

@Stability(Stable)
public CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder requesterPaysEnabled(IResolvable requesterPaysEnabled)

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

Returns:

this

resultConfigurationUpdates

@Stability(Stable)
public CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder resultConfigurationUpdates(IResolvable resultConfigurationUpdates)

Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getResultConfigurationUpdates()

Parameters:

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

this

resultConfigurationUpdates

@Stability(Stable)
public CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.Builder resultConfigurationUpdates(CfnWorkGroupPropsMixin.ResultConfigurationUpdatesProperty resultConfigurationUpdates)

Sets the value of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty.getResultConfigurationUpdates()

Parameters:

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

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty

Throws:

NullPointerException - if any required attribute was not provided