Skip to content
v2.278.0

EncryptionConfigurationProperty Struct ​

If query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_KMS ) and key information.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_athena as athena } from 'aws-cdk-lib';
const encryptionConfigurationProperty: athena.CfnWorkGroup.EncryptionConfigurationProperty = {
  encryptionOption: 'encryptionOption',

  // the properties below are optional
  kmsKey: 'kmsKey',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_athena as athena

encryption_configuration_property = athena.CfnWorkGroup.EncryptionConfigurationProperty(
    encryption_option="encryptionOption",

    # the properties below are optional
    kms_key="kmsKey"
)
java
// 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.*;

EncryptionConfigurationProperty encryptionConfigurationProperty = EncryptionConfigurationProperty.builder()
        .encryptionOption("encryptionOption")

        // the properties below are optional
        .kmsKey("kmsKey")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Athena;

var encryptionConfigurationProperty = new EncryptionConfigurationProperty {
    EncryptionOption = "encryptionOption",

    // the properties below are optional
    KmsKey = "kmsKey"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

encryptionConfigurationProperty := &EncryptionConfigurationProperty{
	EncryptionOption: jsii.String("encryptionOption"),

	// the properties below are optional
	KmsKey: jsii.String("kmsKey"),
}

Properties ​

encryptionOptionstringencryption_optionstrencryptionOptionStringEncryptionOptionstringEncryptionOption*string required #
Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys ( `SSE_S3` ), server-side encryption with KMS-managed keys ( `SSE_KMS` ), or client-side encryption with KMS-managed keys ( `CSE_KMS` ) is used.

If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.

kmsKeyoptionalstringkms_keyoptionalstrkmsKeyoptionalStringKmsKeyoptionalstringKmsKeyoptional*string #
For `SSE_KMS` and `CSE_KMS` , this is the KMS key ARN or ID.