Class: S3ExportTaskDefinition

aws-greengrass-core-sdk.StreamManager~S3ExportTaskDefinition(inputUrl, bucket, key, userMetadata)

S3 Task definition containing all the information necessary to export the data to S3. This will contain the S3 bucket and key as well as the file's URL where the data is stored.

Constructor

new S3ExportTaskDefinition(inputUrl, bucket, key, userMetadata)

Parameters:
Name Type Default Description
inputUrl String null The URL of the file that contains the data to upload. The file should be local on the disk.
bucket String null The name of the S3 bucket that this file should be uploaded to.
key String null The key for the S3 object that this file should be uploaded to. The string can have placeholder expressions which are resolved at upload time. Valid expressions are strings that are valid Java DateTimeFormatter strings. See https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html Example: myKeyNamePrefix/!{timestamp:yyyy/MM/dd}/myKeyNameSuffix.
userMetadata Object null User metadata. For key of a user metadata, callers should not include the internal "x-amz-meta-" prefix. Keys are case insensitive and will appear as lowercase strings on S3, even if they were originally specified with uppercase strings. Reserved key names start with "$aws-gg-" prefix.
Source:

Members

bucket

The name of the S3 bucket that this file should be uploaded to.
Source:

bucket

Source:

inputUrl

The URL of the file that contains the data to upload. The file should be local on the disk.
Source:

inputUrl

Source:

key

The key for the S3 object that this file should be uploaded to. The string can have placeholder expressions which are resolved at upload time. Valid expressions are strings that are valid Java DateTimeFormatter strings. See https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html Example: myKeyNamePrefix/!{timestamp:yyyy/MM/dd}/myKeyNameSuffix.
Source:

key

Source:

userMetadata

User metadata. For key of a user metadata, callers should not include the internal "x-amz-meta-" prefix. Keys are case insensitive and will appear as lowercase strings on S3, even if they were originally specified with uppercase strings. Reserved key names start with "$aws-gg-" prefix.
Source:

userMetadata

Source:

Methods

withBucket(value) → {aws-greengrass-core-sdk.StreamManager.S3ExportTaskDefinition}

Parameters:
Name Type Description
value String The name of the S3 bucket that this file should be uploaded to.
Source:
Returns:
Type
aws-greengrass-core-sdk.StreamManager.S3ExportTaskDefinition

withInputUrl(value) → {aws-greengrass-core-sdk.StreamManager.S3ExportTaskDefinition}

Parameters:
Name Type Description
value String The URL of the file that contains the data to upload. The file should be local on the disk.
Source:
Returns:
Type
aws-greengrass-core-sdk.StreamManager.S3ExportTaskDefinition

withKey(value) → {aws-greengrass-core-sdk.StreamManager.S3ExportTaskDefinition}

Parameters:
Name Type Description
value String The key for the S3 object that this file should be uploaded to. The string can have placeholder expressions which are resolved at upload time. Valid expressions are strings that are valid Java DateTimeFormatter strings. See https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html Example: myKeyNamePrefix/!{timestamp:yyyy/MM/dd}/myKeyNameSuffix.
Source:
Returns:
Type
aws-greengrass-core-sdk.StreamManager.S3ExportTaskDefinition

withUserMetadata(value) → {aws-greengrass-core-sdk.StreamManager.S3ExportTaskDefinition}

Parameters:
Name Type Description
value Object User metadata. For key of a user metadata, callers should not include the internal "x-amz-meta-" prefix. Keys are case insensitive and will appear as lowercase strings on S3, even if they were originally specified with uppercase strings. Reserved key names start with "$aws-gg-" prefix.
Source:
Returns:
Type
aws-greengrass-core-sdk.StreamManager.S3ExportTaskDefinition