Package software.amazon.awscdk.services.athena

Interface CfnWorkGroup.ResultConfigurationUpdatesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWorkGroup.ResultConfigurationUpdatesProperty.Jsii$Proxy

Enclosing class:

CfnWorkGroup

@Stability(Stable)
public static interface CfnWorkGroup.ResultConfigurationUpdatesProperty
extends software.amazon.jsii.JsiiSerializable

The result configuration information about the queries in this workgroup that will be updated.

Includes the updated results location and an updated option for encrypting query results.

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.*;
 ResultConfigurationUpdatesProperty resultConfigurationUpdatesProperty = ResultConfigurationUpdatesProperty.builder()
         .aclConfiguration(AclConfigurationProperty.builder()
                 .s3AclOption("s3AclOption")
                 .build())
         .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                 .encryptionOption("encryptionOption")
                 // the properties below are optional
                 .kmsKey("kmsKey")
                 .build())
         .expectedBucketOwner("expectedBucketOwner")
         .outputLocation("outputLocation")
         .removeAclConfiguration(false)
         .removeEncryptionConfiguration(false)
         .removeExpectedBucketOwner(false)
         .removeOutputLocation(false)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-resultconfigurationupdates.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnWorkGroup.ResultConfigurationUpdatesProperty.Builder	A builder for CfnWorkGroup.ResultConfigurationUpdatesProperty
static final class	CfnWorkGroup.ResultConfigurationUpdatesProperty.Jsii$Proxy	An implementation for CfnWorkGroup.ResultConfigurationUpdatesProperty

Method Summary

Modifier and Type	Method	Description
static CfnWorkGroup.ResultConfigurationUpdatesProperty.Builder	builder()
default Object	getAclConfiguration()	Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results.
default Object	getEncryptionConfiguration()	If query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE-KMS or CSE-KMS) and key information.
default String	getExpectedBucketOwner()	The AWS account ID of the owner of S3 bucket where query results are stored.
default String	getOutputLocation()	The location in Amazon S3 where your query results are stored, such as s3://path/to/query/bucket/.
default Object	getRemoveAclConfiguration()
default Object	getRemoveEncryptionConfiguration()
default Object	getRemoveExpectedBucketOwner()
default Object	getRemoveOutputLocation()

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAclConfiguration

@Stability(Stable)
@Nullable
default Object getAclConfiguration()

Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-resultconfigurationupdates.html#cfn-athena-workgroup-resultconfigurationupdates-aclconfiguration

getEncryptionConfiguration

@Stability(Stable)
@Nullable
default Object getEncryptionConfiguration()

If query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE-KMS or CSE-KMS) and key information.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-resultconfigurationupdates.html#cfn-athena-workgroup-resultconfigurationupdates-encryptionconfiguration

getExpectedBucketOwner

@Stability(Stable)
@Nullable
default String getExpectedBucketOwner()

The AWS account ID of the owner of S3 bucket where query results are stored.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-resultconfigurationupdates.html#cfn-athena-workgroup-resultconfigurationupdates-expectedbucketowner

getOutputLocation

@Stability(Stable)
@Nullable
default String getOutputLocation()

The location in Amazon S3 where your query results are stored, such as s3://path/to/query/bucket/.

To run the query, you must specify the query results location using one of the ways: either for individual queries using either this setting (client-side), or in the workgroup, using WorkGroupConfiguration

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-resultconfigurationupdates.html#cfn-athena-workgroup-resultconfigurationupdates-outputlocation

getRemoveAclConfiguration

@Stability(Stable)
@Nullable
default Object getRemoveAclConfiguration()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-resultconfigurationupdates.html#cfn-athena-workgroup-resultconfigurationupdates-removeaclconfiguration

getRemoveEncryptionConfiguration

@Stability(Stable)
@Nullable
default Object getRemoveEncryptionConfiguration()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-resultconfigurationupdates.html#cfn-athena-workgroup-resultconfigurationupdates-removeencryptionconfiguration

getRemoveExpectedBucketOwner

@Stability(Stable)
@Nullable
default Object getRemoveExpectedBucketOwner()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-resultconfigurationupdates.html#cfn-athena-workgroup-resultconfigurationupdates-removeexpectedbucketowner

getRemoveOutputLocation

@Stability(Stable)
@Nullable
default Object getRemoveOutputLocation()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-resultconfigurationupdates.html#cfn-athena-workgroup-resultconfigurationupdates-removeoutputlocation

builder

@Stability(Stable)
static CfnWorkGroup.ResultConfigurationUpdatesProperty.Builder builder()

Returns:

a CfnWorkGroup.ResultConfigurationUpdatesProperty.Builder of CfnWorkGroup.ResultConfigurationUpdatesProperty