Package software.amazon.awscdk.services.dynamodb

Interface ImportSourceSpecification

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ImportSourceSpecification.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:00.043Z")
@Stability(Stable)
public interface ImportSourceSpecification
extends software.amazon.jsii.JsiiSerializable

Properties for importing data from the S3.

Example:

 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.s3.*;
 IBucket bucket;
 App app = new App();
 Stack stack = new Stack(app, "Stack");
 Table.Builder.create(stack, "Table")
         .partitionKey(Attribute.builder()
                 .name("id")
                 .type(AttributeType.STRING)
                 .build())
         .importSource(ImportSourceSpecification.builder()
                 .compressionType(InputCompressionType.GZIP)
                 .inputFormat(InputFormat.dynamoDBJson())
                 .bucket(bucket)
                 .keyPrefix("prefix")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ImportSourceSpecification.Builder	builder()
IBucket	getBucket()	The S3 bucket that is being imported from.
default String	getBucketOwner()	The account number of the S3 bucket that is being imported from.
default InputCompressionType	getCompressionType()	The compression type of the imported data.
InputFormat	getInputFormat()	The format of the imported data.
default String	getKeyPrefix()	The key prefix shared by all S3 Objects that are being imported.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucket

@Stability(Stable)
@NotNull
IBucket getBucket()

The S3 bucket that is being imported from.

getInputFormat

@Stability(Stable)
@NotNull
InputFormat getInputFormat()

The format of the imported data.

getBucketOwner

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

The account number of the S3 bucket that is being imported from.

Default: - no value

getCompressionType

@Stability(Stable)
@Nullable
default InputCompressionType getCompressionType()

The compression type of the imported data.

Default: InputCompressionType.NONE

getKeyPrefix

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

The key prefix shared by all S3 Objects that are being imported.

Default: - no value

builder

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

Returns:

a ImportSourceSpecification.Builder of ImportSourceSpecification