Package software.amazon.awscdk.services.ec2

Class S3DownloadOptions.Builder

java.lang.Object

software.amazon.awscdk.services.ec2.S3DownloadOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<S3DownloadOptions>

Enclosing interface:

S3DownloadOptions

@Stability(Stable)
public static final class S3DownloadOptions.Builder
extends Object
implements software.amazon.jsii.Builder<S3DownloadOptions>

A builder for S3DownloadOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
S3DownloadOptions.Builder	bucket(IBucketRef bucket)	Sets the value of S3DownloadOptions.getBucket()
S3DownloadOptions.Builder	bucketKey(String bucketKey)	Sets the value of S3DownloadOptions.getBucketKey()
S3DownloadOptions	build()	Builds the configured instance.
S3DownloadOptions.Builder	localFile(String localFile)	Sets the value of S3DownloadOptions.getLocalFile()
S3DownloadOptions.Builder	region(String region)	Sets the value of S3DownloadOptions.getRegion()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

bucket

@Stability(Stable)
public S3DownloadOptions.Builder bucket(IBucketRef bucket)

Sets the value of S3DownloadOptions.getBucket()

Parameters:

bucket - Name of the S3 bucket to download from. This parameter is required.

Returns:

this

bucketKey

@Stability(Stable)
public S3DownloadOptions.Builder bucketKey(String bucketKey)

Sets the value of S3DownloadOptions.getBucketKey()

Parameters:

bucketKey - The key of the file to download. This parameter is required.

Returns:

this

localFile

@Stability(Stable)
public S3DownloadOptions.Builder localFile(String localFile)

Sets the value of S3DownloadOptions.getLocalFile()

Parameters:

localFile - The name of the local file.

Returns:

this

region

@Stability(Stable)
public S3DownloadOptions.Builder region(String region)

Sets the value of S3DownloadOptions.getRegion()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public S3DownloadOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<S3DownloadOptions>

Returns:

a new instance of S3DownloadOptions

Throws:

NullPointerException - if any required attribute was not provided