software.amazon.awscdk.services.s3

Interface Location

All Known Implementing Classes:

Location.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:41.703Z")
public interface Location

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

Example:

 AthenaStartQueryExecution startQueryExecutionJob = AthenaStartQueryExecution.Builder.create(this, "Athena Start Query")
         .queryString(JsonPath.format("select contacts where year={};", JsonPath.stringAt("$.year")))
         .queryExecutionContext(QueryExecutionContext.builder()
                 .databaseName("interactions")
                 .build())
         .resultConfiguration(ResultConfiguration.builder()
                 .encryptionConfiguration(EncryptionConfiguration.builder()
                         .encryptionOption(EncryptionOption.S3_MANAGED)
                         .build())
                 .outputLocation(Location.builder()
                         .bucketName("mybucket")
                         .objectKey("myprefix")
                         .build())
                 .build())
         .integrationPattern(IntegrationPattern.RUN_JOB)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

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

Method Detail

getBucketName

java.lang.String getBucketName()

The name of the S3 Bucket the object is in.

getObjectKey

java.lang.String getObjectKey()

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

getObjectVersion

default java.lang.String getObjectVersion()

The S3 object version.

builder

static Location.Builder builder()

Returns:

a Location.Builder of Location