software.amazon.awscdk.services.ec2

Interface S3DownloadOptions

All Known Implementing Classes:

S3DownloadOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:28.741Z")
public interface S3DownloadOptions

Options when downloading files from S3.

Example:

 import software.amazon.awscdk.services.s3.assets.Asset;
 Instance instance;
 Asset asset = Asset.Builder.create(this, "Asset")
         .path("./configure.sh")
         .build();
 String localPath = instance.userData.addS3DownloadCommand(S3DownloadOptions.builder()
         .bucket(asset.getBucket())
         .bucketKey(asset.getS3ObjectKey())
         .region("us-east-1")
         .build());
 instance.userData.addExecuteFileCommand(ExecuteFileOptions.builder()
         .filePath(localPath)
         .arguments("--verbose -y")
         .build());
 asset.grantRead(instance.getRole());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static S3DownloadOptions.Builder	builder()
IBucket	getBucket() Name of the S3 bucket to download from.
java.lang.String	getBucketKey() The key of the file to download.
default java.lang.String	getLocalFile() The name of the local file.
default java.lang.String	getRegion() The region of the S3 Bucket (needed for access via VPC Gateway).

Method Detail

getBucket

IBucket getBucket()

Name of the S3 bucket to download from.

getBucketKey

java.lang.String getBucketKey()

The key of the file to download.

getLocalFile

default java.lang.String getLocalFile()

The name of the local file.

Default: Linux - /tmp/bucketKey Windows - %TEMP%/bucketKey

getRegion

default java.lang.String getRegion()

The region of the S3 Bucket (needed for access via VPC Gateway).

Default: none

builder

static S3DownloadOptions.Builder builder()

Returns:

a S3DownloadOptions.Builder of S3DownloadOptions