Package software.amazon.awscdk.services.s3

Interface Location

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

Location.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-17T21:37:38.665Z")
@Stability(Stable)
public interface Location
extends software.amazon.jsii.JsiiSerializable

An interface that represents the location of a specific object in an S3 Bucket.

Example:

 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("query-results-bucket")
                         .objectKey("folder")
                         .build())
                 .build())
         .executionParameters(List.of("param1", "param2"))
         .resultReuseConfigurationMaxAge(Duration.minutes(100))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static Location.Builder	builder()
String	getBucketName()	The name of the S3 Bucket the object is in.
String	getObjectKey()	The path inside the Bucket where the object is located at.
default String	getObjectVersion()	The S3 object version.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucketName

@Stability(Stable)
@NotNull
String getBucketName()

The name of the S3 Bucket the object is in.

getObjectKey

@Stability(Stable)
@NotNull
String getObjectKey()

The path inside the Bucket where the object is located at.

getObjectVersion

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

The S3 object version.

builder

@Stability(Stable)
static Location.Builder builder()

Returns:

a Location.Builder of Location