software.amazon.awscdk.services.athena

Interface CfnWorkGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWorkGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.697Z")
 @Stability(value=Stable)
public interface CfnWorkGroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnWorkGroup`.

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.*;
 CfnWorkGroupProps cfnWorkGroupProps = CfnWorkGroupProps.builder()
         .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	Interface and Description
static class	CfnWorkGroupProps.Builder A builder for CfnWorkGroupProps
static class	CfnWorkGroupProps.Jsii$Proxy An implementation for CfnWorkGroupProps

Method Summary

Modifier and Type	Method and Description
static CfnWorkGroupProps.Builder	builder()
default String	getDescription() The workgroup description.
String	getName() The workgroup name.
default Object	getRecursiveDeleteOption() The option to delete a workgroup and its contents even if the workgroup contains any named queries.
default String	getState() The state of the workgroup: ENABLED or DISABLED.
default List<CfnTag>	getTags() The tags (key-value pairs) to associate with this resource.
default 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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getName

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

The workgroup name.

getDescription

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

The workgroup description.

getRecursiveDeleteOption

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

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
default String getState()

The state of the workgroup: ENABLED or DISABLED.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

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

getWorkGroupConfiguration

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

builder

@Stability(value=Stable)
static CfnWorkGroupProps.Builder builder()

Returns:

a CfnWorkGroupProps.Builder of CfnWorkGroupProps