Package software.amazon.awscdk.services.athena

Interface CfnWorkGroup.ResultConfigurationProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnWorkGroup.ResultConfigurationProperty.Jsii$Proxy
Enclosing class:
CfnWorkGroup
@Stability(Stable) public static interface CfnWorkGroup.ResultConfigurationProperty extends software.amazon.jsii.JsiiSerializable
The location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation results.

These are known as "client-side settings". If workgroup settings override client-side settings, then the query uses the workgroup settings.

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.*;
 ResultConfigurationProperty resultConfigurationProperty = ResultConfigurationProperty.builder()
         .aclConfiguration(AclConfigurationProperty.builder()
                 .s3AclOption("s3AclOption")
                 .build())
         .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                 .encryptionOption("encryptionOption")
                 // the properties below are optional
                 .kmsKey("kmsKey")
                 .build())
         .expectedBucketOwner("expectedBucketOwner")
         .outputLocation("outputLocation")
         .build();

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

      Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL . This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ACL configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See EnforceWorkGroupConfiguration .

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

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

    • getExpectedBucketOwner

      @Stability(Stable) @Nullable default String getExpectedBucketOwner()
      The 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 account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.

      This is a client-side setting. 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 EnforceWorkGroupConfiguration .

    • 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 a query, you must specify the query results location using either a client-side setting for individual queries or a location specified by the workgroup. If workgroup settings override client-side settings, then the query uses the location specified for the workgroup. If no query location is set, Athena issues an error. For more information, see Working with Query Results, Output Files, and Query History and EnforceWorkGroupConfiguration .

    • builder

      @Stability(Stable) static CfnWorkGroup.ResultConfigurationProperty.Builder builder()
      Returns:
      a CfnWorkGroup.ResultConfigurationProperty.Builder of CfnWorkGroup.ResultConfigurationProperty