software.amazon.awscdk.services.athena

Class CfnWorkGroup

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.athena.CfnWorkGroup

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:35.498Z")
public class CfnWorkGroup
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Athena::WorkGroup`.

The AWS::Athena::WorkGroup resource specifies an Amazon Athena workgroup, which contains a name, description, creation time, state, and other configuration, listed under WorkGroupConfiguration . Each workgroup enables you to isolate queries for you or your group from other queries in the same account. For more information, see CreateWorkGroup in the Amazon Athena API Reference .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.athena.*;
 CfnWorkGroup cfnWorkGroup = CfnWorkGroup.Builder.create(this, "MyCfnWorkGroup")
         .name("name")
         // the properties below are optional
         .description("description")
         .recursiveDeleteOption(false)
         .state("state")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .workGroupConfiguration(WorkGroupConfigurationProperty.builder()
                 .additionalConfiguration("additionalConfiguration")
                 .bytesScannedCutoffPerQuery(123)
                 .customerContentEncryptionConfiguration(CustomerContentEncryptionConfigurationProperty.builder()
                         .kmsKey("kmsKey")
                         .build())
                 .enforceWorkGroupConfiguration(false)
                 .engineVersion(EngineVersionProperty.builder()
                         .effectiveEngineVersion("effectiveEngineVersion")
                         .selectedEngineVersion("selectedEngineVersion")
                         .build())
                 .executionRole("executionRole")
                 .publishCloudWatchMetricsEnabled(false)
                 .requesterPaysEnabled(false)
                 .resultConfiguration(ResultConfigurationProperty.builder()
                         .aclConfiguration(AclConfigurationProperty.builder()
                                 .s3AclOption("s3AclOption")
                                 .build())
                         .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                                 .encryptionOption("encryptionOption")
                                 // the properties below are optional
                                 .kmsKey("kmsKey")
                                 .build())
                         .expectedBucketOwner("expectedBucketOwner")
                         .outputLocation("outputLocation")
                         .build())
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnWorkGroup.AclConfigurationProperty Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results.
static class	CfnWorkGroup.Builder A fluent builder for CfnWorkGroup.
static interface	CfnWorkGroup.CustomerContentEncryptionConfigurationProperty Specifies the KMS key that is used to encrypt the user's data stores in Athena.
static interface	CfnWorkGroup.EncryptionConfigurationProperty If query results are encrypted in Amazon S3, indicates the encryption option used (for example, `SSE_KMS` or `CSE_KMS` ) and key information.
static interface	CfnWorkGroup.EngineVersionProperty The Athena engine version for running queries, or the PySpark engine version for running sessions.
static interface	CfnWorkGroup.ResultConfigurationProperty The location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation results.
static interface	CfnWorkGroup.WorkGroupConfigurationProperty 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.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnWorkGroup(Construct scope, java.lang.String id, CfnWorkGroupProps props) Create a new `AWS::Athena::WorkGroup`.
protected	CfnWorkGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnWorkGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrCreationTime() The date and time the workgroup was created, as a UNIX timestamp in seconds.
java.lang.String	getAttrWorkGroupConfigurationEngineVersionEffectiveEngineVersion()
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() The workgroup description.
java.lang.String	getName() The workgroup name.
java.lang.Object	getRecursiveDeleteOption() The option to delete a workgroup and its contents even if the workgroup contains any named queries.
java.lang.String	getState() The state of the workgroup: ENABLED or DISABLED.
TagManager	getTags() The tags (key-value pairs) to associate with this resource.
java.lang.Object	getWorkGroupConfiguration() 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.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDescription(java.lang.String value) The workgroup description.
void	setName(java.lang.String value) The workgroup name.
void	setRecursiveDeleteOption(java.lang.Boolean value) The option to delete a workgroup and its contents even if the workgroup contains any named queries.
void	setRecursiveDeleteOption(IResolvable value) The option to delete a workgroup and its contents even if the workgroup contains any named queries.
void	setState(java.lang.String value) The state of the workgroup: ENABLED or DISABLED.
void	setWorkGroupConfiguration(CfnWorkGroup.WorkGroupConfigurationProperty value) 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.
void	setWorkGroupConfiguration(IResolvable value) 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.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnWorkGroup

protected CfnWorkGroup(software.amazon.jsii.JsiiObjectRef objRef)

CfnWorkGroup

protected CfnWorkGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnWorkGroup

public CfnWorkGroup(Construct scope,
                    java.lang.String id,
                    CfnWorkGroupProps props)

Create a new `AWS::Athena::WorkGroup`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCreationTime

public java.lang.String getAttrCreationTime()

The date and time the workgroup was created, as a UNIX timestamp in seconds.

For example: 1582761016 .

getAttrWorkGroupConfigurationEngineVersionEffectiveEngineVersion

public java.lang.String getAttrWorkGroupConfigurationEngineVersionEffectiveEngineVersion()

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

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

getName

public java.lang.String getName()

The workgroup name.

setName

public void setName(java.lang.String value)

The workgroup name.

getDescription

public java.lang.String getDescription()

The workgroup description.

setDescription

public void setDescription(java.lang.String value)

The workgroup description.

getRecursiveDeleteOption

public java.lang.Object getRecursiveDeleteOption()

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

The default is false.

setRecursiveDeleteOption

public void setRecursiveDeleteOption(java.lang.Boolean value)

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

The default is false.

setRecursiveDeleteOption

public void setRecursiveDeleteOption(IResolvable value)

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

The default is false.

getState

public java.lang.String getState()

The state of the workgroup: ENABLED or DISABLED.

setState

public void setState(java.lang.String value)

The state of the workgroup: ENABLED or DISABLED.

getWorkGroupConfiguration

public java.lang.Object getWorkGroupConfiguration()

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.

setWorkGroupConfiguration

public void setWorkGroupConfiguration(IResolvable value)

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.

setWorkGroupConfiguration

public void setWorkGroupConfiguration(CfnWorkGroup.WorkGroupConfigurationProperty value)

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.