Package software.amazon.awscdk.services.athena

Class CfnWorkGroup.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnWorkGroup>

Enclosing class:

CfnWorkGroup

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

A fluent builder for CfnWorkGroup.

Method Summary

Modifier and Type	Method	Description
CfnWorkGroup	build()
static CfnWorkGroup.Builder	create(software.constructs.Construct scope, String id)
CfnWorkGroup.Builder	description(String description)	The workgroup description.
CfnWorkGroup.Builder	name(String name)	The workgroup name.
CfnWorkGroup.Builder	recursiveDeleteOption(Boolean recursiveDeleteOption)	The option to delete a workgroup and its contents even if the workgroup contains any named queries.
CfnWorkGroup.Builder	recursiveDeleteOption(IResolvable recursiveDeleteOption)	The option to delete a workgroup and its contents even if the workgroup contains any named queries.
CfnWorkGroup.Builder	state(String state)	The state of the workgroup: ENABLED or DISABLED.
CfnWorkGroup.Builder	tags(List<? extends CfnTag> tags)	The tags (key-value pairs) to associate with this resource.
CfnWorkGroup.Builder	workGroupConfiguration(IResolvable workGroupConfiguration)	The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether Amazon CloudWatch Metrics are enabled for the workgroup, and the limit for the amount of bytes scanned (cutoff) per query, if it is specified.
CfnWorkGroup.Builder	workGroupConfiguration(CfnWorkGroup.WorkGroupConfigurationProperty workGroupConfiguration)	The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether Amazon CloudWatch Metrics are enabled for the workgroup, and the limit for the amount of bytes scanned (cutoff) per query, if it is specified.
CfnWorkGroup.Builder	workGroupConfigurationUpdates(IResolvable workGroupConfigurationUpdates)	Deprecated. this property has been deprecated
CfnWorkGroup.Builder	workGroupConfigurationUpdates(CfnWorkGroup.WorkGroupConfigurationUpdatesProperty workGroupConfigurationUpdates)	Deprecated. this property has been deprecated

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnWorkGroup.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnWorkGroup.Builder.

name

@Stability(Stable)
public CfnWorkGroup.Builder name(String name)

The workgroup name.

Parameters:

name - The workgroup name. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.html#cfn-athena-workgroup-name

description

@Stability(Stable)
public CfnWorkGroup.Builder description(String description)

The workgroup description.

Parameters:

description - The workgroup description. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.html#cfn-athena-workgroup-description

recursiveDeleteOption

@Stability(Stable)
public CfnWorkGroup.Builder recursiveDeleteOption(Boolean recursiveDeleteOption)

The option to delete a workgroup and its contents even if the workgroup contains any named queries.

The default is false.

Parameters:

recursiveDeleteOption - The option to delete a workgroup and its contents even if the workgroup contains any named queries. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.html#cfn-athena-workgroup-recursivedeleteoption

recursiveDeleteOption

@Stability(Stable)
public CfnWorkGroup.Builder recursiveDeleteOption(IResolvable recursiveDeleteOption)

The option to delete a workgroup and its contents even if the workgroup contains any named queries.

The default is false.

Parameters:

recursiveDeleteOption - The option to delete a workgroup and its contents even if the workgroup contains any named queries. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.html#cfn-athena-workgroup-recursivedeleteoption

state

@Stability(Stable)
public CfnWorkGroup.Builder state(String state)

The state of the workgroup: ENABLED or DISABLED.

Parameters:

state - The state of the workgroup: ENABLED or DISABLED. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.html#cfn-athena-workgroup-state

tags

@Stability(Stable)
public CfnWorkGroup.Builder tags(List<? extends CfnTag> tags)

The tags (key-value pairs) to associate with this resource.

Parameters:

tags - The tags (key-value pairs) to associate with this resource. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.html#cfn-athena-workgroup-tags

workGroupConfiguration

@Stability(Stable)
public CfnWorkGroup.Builder workGroupConfiguration(IResolvable workGroupConfiguration)

The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether Amazon CloudWatch Metrics are enabled for the workgroup, and the limit for the amount of bytes scanned (cutoff) per query, if it is specified.

The EnforceWorkGroupConfiguration option determines whether workgroup settings override client-side query settings.

Parameters:

workGroupConfiguration - The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether Amazon CloudWatch Metrics are enabled for the workgroup, and the limit for the amount of bytes scanned (cutoff) per query, if it is specified. This parameter is required.

Returns:

this

See Also:

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

workGroupConfiguration

@Stability(Stable)
public CfnWorkGroup.Builder workGroupConfiguration(CfnWorkGroup.WorkGroupConfigurationProperty workGroupConfiguration)

The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether Amazon CloudWatch Metrics are enabled for the workgroup, and the limit for the amount of bytes scanned (cutoff) per query, if it is specified.

The EnforceWorkGroupConfiguration option determines whether workgroup settings override client-side query settings.

Parameters:

workGroupConfiguration - The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether Amazon CloudWatch Metrics are enabled for the workgroup, and the limit for the amount of bytes scanned (cutoff) per query, if it is specified. This parameter is required.

Returns:

this

See Also:

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

workGroupConfigurationUpdates

@Stability(Deprecated)
@Deprecated
public CfnWorkGroup.Builder workGroupConfigurationUpdates(IResolvable workGroupConfigurationUpdates)

Deprecated.

this property has been deprecated

(deprecated) 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.

Parameters:

workGroupConfigurationUpdates - 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. This parameter is required.

Returns:

this

See Also:

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

workGroupConfigurationUpdates

@Stability(Deprecated)
@Deprecated
public CfnWorkGroup.Builder workGroupConfigurationUpdates(CfnWorkGroup.WorkGroupConfigurationUpdatesProperty workGroupConfigurationUpdates)

Deprecated.

this property has been deprecated

(deprecated) 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.

Parameters:

workGroupConfigurationUpdates - 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. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnWorkGroup build()

Specified by:

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

Returns:

a newly built instance of CfnWorkGroup.