software.amazon.awscdk.services.athena

Class CfnWorkGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.athena.CfnWorkGroup

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.694Z")
 @Stability(value=Stable)
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()
                 .bytesScannedCutoffPerQuery(123)
                 .enforceWorkGroupConfiguration(false)
                 .engineVersion(EngineVersionProperty.builder()
                         .effectiveEngineVersion("effectiveEngineVersion")
                         .selectedEngineVersion("selectedEngineVersion")
                         .build())
                 .publishCloudWatchMetricsEnabled(false)
                 .requesterPaysEnabled(false)
                 .resultConfiguration(ResultConfigurationProperty.builder()
                         .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                                 .encryptionOption("encryptionOption")
                                 // the properties below are optional
                                 .kmsKey("kmsKey")
                                 .build())
                         .outputLocation("outputLocation")
                         .build())
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnWorkGroup.Builder A fluent builder for CfnWorkGroup.
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.
static interface	CfnWorkGroup.ResultConfigurationProperty The location in Amazon S3 where query results are stored and the encryption option, if any, used for query 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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnWorkGroup(software.constructs.Construct scope, 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
String	getAttrCreationTime() The date and time the workgroup was created, as a UNIX timestamp in seconds.
String	getAttrWorkGroupConfigurationEngineVersionEffectiveEngineVersion()
protected Map<String,Object>	getCfnProperties()
String	getDescription() The workgroup description.
String	getName() The workgroup name.
Object	getRecursiveDeleteOption() The option to delete a workgroup and its contents even if the workgroup contains any named queries.
String	getState() The state of the workgroup: ENABLED or DISABLED.
TagManager	getTags() The tags (key-value pairs) to associate with this resource.
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) The workgroup description.
void	setName(String value) The workgroup name.
void	setRecursiveDeleteOption(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(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.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnWorkGroup(@NotNull
                                             software.constructs.Construct scope,
                                             @NotNull
                                             String id,
                                             @NotNull
                                             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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCreationTime

@Stability(value=Stable)
 @NotNull
public String getAttrCreationTime()

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

For example: 1582761016 .

getAttrWorkGroupConfigurationEngineVersionEffectiveEngineVersion

@Stability(value=Stable)
 @NotNull
public String getAttrWorkGroupConfigurationEngineVersionEffectiveEngineVersion()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The workgroup name.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The workgroup name.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

The workgroup description.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

The workgroup description.

getRecursiveDeleteOption

@Stability(value=Stable)
 @Nullable
public Object getRecursiveDeleteOption()

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

The default is false.

setRecursiveDeleteOption

@Stability(value=Stable)
public void setRecursiveDeleteOption(@Nullable
                                                              Boolean value)

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

The default is false.

setRecursiveDeleteOption

@Stability(value=Stable)
public void setRecursiveDeleteOption(@Nullable
                                                              IResolvable value)

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

The default is false.

getState

@Stability(value=Stable)
 @Nullable
public String getState()

The state of the workgroup: ENABLED or DISABLED.

setState

@Stability(value=Stable)
public void setState(@Nullable
                                              String value)

The state of the workgroup: ENABLED or DISABLED.

getWorkGroupConfiguration

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setWorkGroupConfiguration(@Nullable
                                                               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.

setWorkGroupConfiguration

@Stability(value=Stable)
public void setWorkGroupConfiguration(@Nullable
                                                               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.