JSDoc: Class: S3ExportTaskExecutorConfig

Constructor

new S3ExportTaskExecutorConfig(identifier, sizeThresholdForMultipartUploadBytes, priority, disabled, statusConfig)

Parameters:

Name	Type	Default	Description
`identifier`	String	null	A unique identifier to identify this individual upload task. Must be an alphanumeric string including spaces, commas, periods, hyphens, and underscores with length between 1 and 255.
`sizeThresholdForMultipartUploadBytes`	Number	null	The size threshold in bytes for when to use multipart uploads. Uploads over this size will automatically use a multipart upload strategy, while uploads equal or smaller than this threshold will use a single connection to upload the whole object.
`priority`	Number	null	Priority for this upload task. Lower values are higher priority. If not specified it will have the lowest priority.
`disabled`	Boolean	null	Enable or disable this export. Default is false.
`statusConfig`	aws-greengrass-core-sdk.StreamManager.StatusConfig	null	Event status configuration that specifies the target status stream and verbosity.

Source:

stream-manager/data/index.js, line 4516

Members

disabled

Enable or disable this export. Default is false.

Source:

stream-manager/data/index.js, line 4639

disabled

Source:

stream-manager/data/index.js, line 4645

identifier

A unique identifier to identify this individual upload task. Must be an alphanumeric string including spaces, commas, periods, hyphens, and underscores with length between 1 and 255.

Source:

stream-manager/data/index.js, line 4556

identifier

Source:

stream-manager/data/index.js, line 4563

priority

Priority for this upload task. Lower values are higher priority. If not specified it will have the lowest priority.

Source:

stream-manager/data/index.js, line 4612

priority

Source:

stream-manager/data/index.js, line 4618

sizeThresholdForMultipartUploadBytes

The size threshold in bytes for when to use multipart uploads. Uploads over this size will automatically use a multipart upload strategy, while uploads equal or smaller than this threshold will use a single connection to upload the whole object.

Source:

stream-manager/data/index.js, line 4585

sizeThresholdForMultipartUploadBytes

Source:

stream-manager/data/index.js, line 4591

statusConfig

Event status configuration that specifies the target status stream and verbosity.

Source:

stream-manager/data/index.js, line 4666

statusConfig

Source:

stream-manager/data/index.js, line 4672

Methods

withDisabled(value) → {aws-greengrass-core-sdk.StreamManager.S3ExportTaskExecutorConfig}

Parameters:

Name	Type	Description
`value`	Boolean	Enable or disable this export. Default is false.

Source:

stream-manager/data/index.js, line 4656

Returns:

Type: aws-greengrass-core-sdk.StreamManager.S3ExportTaskExecutorConfig

withIdentifier(value) → {aws-greengrass-core-sdk.StreamManager.S3ExportTaskExecutorConfig}

Parameters:

Name	Type	Description
`value`	String	A unique identifier to identify this individual upload task. Must be an alphanumeric string including spaces, commas, periods, hyphens, and underscores with length between 1 and 255.

Source:

stream-manager/data/index.js, line 4575

Returns:

Type: aws-greengrass-core-sdk.StreamManager.S3ExportTaskExecutorConfig

withPriority(value) → {aws-greengrass-core-sdk.StreamManager.S3ExportTaskExecutorConfig}

Parameters:

Name	Type	Description
`value`	Number	Priority for this upload task. Lower values are higher priority. If not specified it will have the lowest priority.

Source:

stream-manager/data/index.js, line 4629

Returns:

Type: aws-greengrass-core-sdk.StreamManager.S3ExportTaskExecutorConfig

withSizeThresholdForMultipartUploadBytes(value) → {aws-greengrass-core-sdk.StreamManager.S3ExportTaskExecutorConfig}

Parameters:

Name	Type	Description
`value`	Number	The size threshold in bytes for when to use multipart uploads. Uploads over this size will automatically use a multipart upload strategy, while uploads equal or smaller than this threshold will use a single connection to upload the whole object.

Source:

stream-manager/data/index.js, line 4602

Returns:

Type: aws-greengrass-core-sdk.StreamManager.S3ExportTaskExecutorConfig

withStatusConfig(value) → {aws-greengrass-core-sdk.StreamManager.S3ExportTaskExecutorConfig}

Parameters:

Name	Type	Description
`value`	aws-greengrass-core-sdk.StreamManager.StatusConfig	Event status configuration that specifies the target status stream and verbosity.

Source:

stream-manager/data/index.js, line 4683

Returns:

Type: aws-greengrass-core-sdk.StreamManager.S3ExportTaskExecutorConfig