Skip to content
v2.277.0

EncryptionOption Enum ​

Encryption Options of the S3 bucket.

Example ​

ts
const startQueryExecutionJob = new tasks.AthenaStartQueryExecution(this, 'Start Athena Query', {
  queryString: sfn.JsonPath.stringAt('$.queryString'),
  queryExecutionContext: {
    databaseName: 'mydatabase',
  },
  resultConfiguration: {
    encryptionConfiguration: {
      encryptionOption: tasks.EncryptionOption.S3_MANAGED,
    },
    outputLocation: {
      bucketName: 'amzn-s3-demo-bucket',
      objectKey: 'folder',
    },
  },
  executionParameters: ['param1', 'param2'],
});
python
start_query_execution_job = tasks.AthenaStartQueryExecution(self, "Start Athena Query",
    query_string=sfn.JsonPath.string_at("$.queryString"),
    query_execution_context=tasks.QueryExecutionContext(
        database_name="mydatabase"
    ),
    result_configuration=tasks.ResultConfiguration(
        encryption_configuration=tasks.EncryptionConfiguration(
            encryption_option=tasks.EncryptionOption.S3_MANAGED
        ),
        output_location=s3.Location(
            bucket_name="amzn-s3-demo-bucket",
            object_key="folder"
        )
    ),
    execution_parameters=["param1", "param2"]
)
java
AthenaStartQueryExecution startQueryExecutionJob = AthenaStartQueryExecution.Builder.create(this, "Start Athena Query")
        .queryString(JsonPath.stringAt("$.queryString"))
        .queryExecutionContext(QueryExecutionContext.builder()
                .databaseName("mydatabase")
                .build())
        .resultConfiguration(ResultConfiguration.builder()
                .encryptionConfiguration(EncryptionConfiguration.builder()
                        .encryptionOption(EncryptionOption.S3_MANAGED)
                        .build())
                .outputLocation(Location.builder()
                        .bucketName("amzn-s3-demo-bucket")
                        .objectKey("folder")
                        .build())
                .build())
        .executionParameters(List.of("param1", "param2"))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
var startQueryExecutionJob = new AthenaStartQueryExecution(this, "Start Athena Query", new AthenaStartQueryExecutionProps {
    QueryString = JsonPath.StringAt("$.queryString"),
    QueryExecutionContext = new QueryExecutionContext {
        DatabaseName = "mydatabase"
    },
    ResultConfiguration = new ResultConfiguration {
        EncryptionConfiguration = new EncryptionConfiguration {
            EncryptionOption = EncryptionOption.S3_MANAGED
        },
        OutputLocation = new Location {
            BucketName = "amzn-s3-demo-bucket",
            ObjectKey = "folder"
        }
    },
    ExecutionParameters = new [] { "param1", "param2" }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
startQueryExecutionJob := tasks.NewAthenaStartQueryExecution(this, jsii.String("Start Athena Query"), &AthenaStartQueryExecutionProps{
	QueryString: sfn.JsonPath_StringAt(jsii.String("$.queryString")),
	QueryExecutionContext: &QueryExecutionContext{
		DatabaseName: jsii.String("mydatabase"),
	},
	ResultConfiguration: &ResultConfiguration{
		EncryptionConfiguration: &EncryptionConfiguration{
			EncryptionOption: tasks.EncryptionOption_S3_MANAGED,
		},
		OutputLocation: &Location{
			BucketName: jsii.String("amzn-s3-demo-bucket"),
			ObjectKey: jsii.String("folder"),
		},
	},
	ExecutionParameters: []*string{
		jsii.String("param1"),
		jsii.String("param2"),
	},
})

Members ​

MemberDescription
S3_MANAGEDServer side encryption (SSE) with an Amazon S3-managed key.
KMSServer-side encryption (SSE) with an AWS KMS key managed by the account owner.
CLIENT_SIDE_KMSClient-side encryption (CSE) with an AWS KMS key managed by the account owner.

Referenced by ​