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.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:16.070Z")
 @Stability(value=Stable)
public interface CfnWorkGroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::Athena::WorkGroup`.

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())
         .workGroupConfigurationUpdates(WorkGroupConfigurationUpdatesProperty.builder()
                 .bytesScannedCutoffPerQuery(123)
                 .enforceWorkGroupConfiguration(false)
                 .engineVersion(EngineVersionProperty.builder()
                         .effectiveEngineVersion("effectiveEngineVersion")
                         .selectedEngineVersion("selectedEngineVersion")
                         .build())
                 .publishCloudWatchMetricsEnabled(false)
                 .removeBytesScannedCutoffPerQuery(false)
                 .requesterPaysEnabled(false)
                 .resultConfigurationUpdates(ResultConfigurationUpdatesProperty.builder()
                         .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                                 .encryptionOption("encryptionOption")
                                 // the properties below are optional
                                 .kmsKey("kmsKey")
                                 .build())
                         .outputLocation("outputLocation")
                         .removeEncryptionConfiguration(false)
                         .removeOutputLocation(false)
                         .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() `AWS::Athena::WorkGroup.Description`.
String	getName() `AWS::Athena::WorkGroup.Name`.
default Object	getRecursiveDeleteOption() `AWS::Athena::WorkGroup.RecursiveDeleteOption`.
default String	getState() `AWS::Athena::WorkGroup.State`.
default List<CfnTag>	getTags() `AWS::Athena::WorkGroup.Tags`.
default Object	getWorkGroupConfiguration() `AWS::Athena::WorkGroup.WorkGroupConfiguration`.
default Object	getWorkGroupConfigurationUpdates() `AWS::Athena::WorkGroup.WorkGroupConfigurationUpdates`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDescription

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

`AWS::Athena::WorkGroup.Description`.

getName

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

`AWS::Athena::WorkGroup.Name`.

getRecursiveDeleteOption

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

`AWS::Athena::WorkGroup.RecursiveDeleteOption`.

getState

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

`AWS::Athena::WorkGroup.State`.

getTags

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

`AWS::Athena::WorkGroup.Tags`.

getWorkGroupConfiguration

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

`AWS::Athena::WorkGroup.WorkGroupConfiguration`.

getWorkGroupConfigurationUpdates

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

`AWS::Athena::WorkGroup.WorkGroupConfigurationUpdates`.

builder

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

Returns:

a CfnWorkGroupProps.Builder of CfnWorkGroupProps