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 information about the updates in the query results, such as output location and encryption configuration for the 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()	The ACL configuration for the query results.
default Object	getEncryptionConfiguration()	The encryption configuration for the query results.
default String	getExpectedBucketOwner()	The AWS account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration$OutputLocation .
default String	getOutputLocation()	The location in Amazon S3 where your query results are stored, such as s3://path/to/query/bucket/ .
default Object	getRemoveAclConfiguration()	If set to true , indicates that the previously-specified ACL configuration for queries in this workgroup should be ignored and set to null.
default Object	getRemoveEncryptionConfiguration()	If set to "true", indicates that the previously-specified encryption configuration (also known as the client-side setting) for queries in this workgroup should be ignored and set to null.
default Object	getRemoveExpectedBucketOwner()	If set to "true", removes the AWS account ID previously specified for ResultConfiguration$ExpectedBucketOwner .
default Object	getRemoveOutputLocation()	If set to "true", indicates that the previously-specified query results location (also known as a client-side setting) for queries in this workgroup should be ignored and set to null.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAclConfiguration

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

The ACL configuration for the 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()

The encryption configuration for the query results.

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 that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration$OutputLocation .

If set, Athena uses the value for ExpectedBucketOwner when it makes Amazon S3 calls to your specified output location. If the ExpectedBucketOwner AWS account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.

If workgroup settings override client-side settings, then the query uses the ExpectedBucketOwner setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings .

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/ .

For more information, see Query Results If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup. The "workgroup settings override" is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See EnforceWorkGroupConfiguration .

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()

If set to true , indicates that the previously-specified ACL configuration for queries in this workgroup should be ignored and set to null.

If set to false or not set, and a value is present in the AclConfiguration of ResultConfigurationUpdates , the AclConfiguration in the workgroup's ResultConfiguration is updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings .

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()

If set to "true", indicates that the previously-specified encryption configuration (also known as the client-side setting) for queries in this workgroup should be ignored and set to null.

If set to "false" or not set, and a value is present in the EncryptionConfiguration in ResultConfigurationUpdates (the client-side setting), the EncryptionConfiguration in the workgroup's ResultConfiguration will be updated with the new value. For more information, see Override Client-Side Settings .

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()

If set to "true", removes the AWS account ID previously specified for ResultConfiguration$ExpectedBucketOwner .

If set to "false" or not set, and a value is present in the ExpectedBucketOwner in ResultConfigurationUpdates (the client-side setting), the ExpectedBucketOwner in the workgroup's ResultConfiguration is updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings .

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()

If set to "true", indicates that the previously-specified query results location (also known as a client-side setting) for queries in this workgroup should be ignored and set to null.

If set to "false" or not set, and a value is present in the OutputLocation in ResultConfigurationUpdates (the client-side setting), the OutputLocation in the workgroup's ResultConfiguration will be updated with the new value. For more information, see Override Client-Side Settings .

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