JSDoc: Class: KinesisConfig

Constructor

new KinesisConfig(identifier, kinesisStreamName, batchSize, batchIntervalMillis, priority, startSequenceNumber, disabled)

Parameters:

Name	Type	Default	Description
`identifier`	String	null	A unique identifier to identify this individual upload stream. Must be an alphanumeric string including spaces, commas, periods, hyphens, and underscores with length between 1 and 255.
`kinesisStreamName`	String	null	The name of the Kinesis data stream that this exporter should upload to.
`batchSize`	Number	null	The maximum size of a batch to send to Kinesis. Messages will be queued until the batch size is reached, after which they will then be uploaded. If unspecified the default will be 500. If both batchSize and batchIntervalMillis are specified, then messages will be eligible for upload when either condition is met. The batch size must be between 1 and 500.
`batchIntervalMillis`	Number	null	The time in milliseconds between the earliest un-uploaded message and the current time. If this time is exceeded, messages will be uploaded in the next batch. If unspecified messages will be eligible for upload immediately. If both batchSize and batchIntervalMillis are specified, then messages will be eligible for upload when either condition is met. The minimum value is 60000 milliseconds and the maximum is 9223372036854 milliseconds.
`priority`	Number	null	Priority for this upload stream. Lower values are higher priority. If not specified it will have the lowest priority.
`startSequenceNumber`	Number	null	The sequence number of the message to use as the starting message in the export. Default is 0. The sequence number provided should be less than the newest sequence number in the stream, i.e., sequence number of the last messaged appended. To find the newest sequence number, describe the stream and then check the storage status of the returned MessageStreamInfo object.
`disabled`	Boolean	null	Enable or disable this export. Default is false.

Source:

data/index.js, line 3924

Members

batchIntervalMillis

The time in milliseconds between the earliest un-uploaded message and the current time. If this time is exceeded, messages will be uploaded in the next batch. If unspecified messages will be eligible for upload immediately. If both batchSize and batchIntervalMillis are specified, then messages will be eligible for upload when either condition is met. The minimum value is 60000 milliseconds and the maximum is 9223372036854 milliseconds.

Source:

data/index.js, line 4067

batchIntervalMillis

Source:

data/index.js, line 4075

batchSize

The maximum size of a batch to send to Kinesis. Messages will be queued until the batch size is reached, after which they will then be uploaded. If unspecified the default will be 500. If both batchSize and batchIntervalMillis are specified, then messages will be eligible for upload when either condition is met. The batch size must be between 1 and 500.

Source:

data/index.js, line 4034

batchSize

Source:

data/index.js, line 4042

disabled

Enable or disable this export. Default is false.

Source:

data/index.js, line 4152

disabled

Source:

data/index.js, line 4158

identifier

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

Source:

data/index.js, line 3976

identifier

Source:

data/index.js, line 3983

kinesisStreamName

The name of the Kinesis data stream that this exporter should upload to.

Source:

data/index.js, line 4005

kinesisStreamName

Source:

data/index.js, line 4011

priority

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

Source:

data/index.js, line 4098

priority

Source:

data/index.js, line 4104

startSequenceNumber

The sequence number of the message to use as the starting message in the export. Default is 0. The sequence number provided should be less than the newest sequence number in the stream, i.e., sequence number of the last messaged appended. To find the newest sequence number, describe the stream and then check the storage status of the returned MessageStreamInfo object.

Source:

data/index.js, line 4125

startSequenceNumber

Source:

data/index.js, line 4131

Methods

withBatchIntervalMillis(value) → {aws-greengrass-core-sdk.StreamManager.KinesisConfig}

Parameters:

Name	Type	Description
`value`	Number	The time in milliseconds between the earliest un-uploaded message and the current time. If this time is exceeded, messages will be uploaded in the next batch. If unspecified messages will be eligible for upload immediately. If both batchSize and batchIntervalMillis are specified, then messages will be eligible for upload when either condition is met. The minimum value is 60000 milliseconds and the maximum is 9223372036854 milliseconds.

Source:

data/index.js, line 4088

Returns:

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

withBatchSize(value) → {aws-greengrass-core-sdk.StreamManager.KinesisConfig}

Parameters:

Name	Type	Description
`value`	Number	The maximum size of a batch to send to Kinesis. Messages will be queued until the batch size is reached, after which they will then be uploaded. If unspecified the default will be 500. If both batchSize and batchIntervalMillis are specified, then messages will be eligible for upload when either condition is met. The batch size must be between 1 and 500.

Source:

data/index.js, line 4055

Returns:

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

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

Parameters:

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

Source:

data/index.js, line 4169

Returns:

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

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

Parameters:

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

Source:

data/index.js, line 3995

Returns:

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

withKinesisStreamName(value) → {aws-greengrass-core-sdk.StreamManager.KinesisConfig}

Parameters:

Name	Type	Description
`value`	String	The name of the Kinesis data stream that this exporter should upload to.

Source:

data/index.js, line 4022

Returns:

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

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

Parameters:

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

Source:

data/index.js, line 4115

Returns:

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

withStartSequenceNumber(value) → {aws-greengrass-core-sdk.StreamManager.KinesisConfig}

Parameters:

Name	Type	Description
`value`	Number	The sequence number of the message to use as the starting message in the export. Default is 0. The sequence number provided should be less than the newest sequence number in the stream, i.e., sequence number of the last messaged appended. To find the newest sequence number, describe the stream and then check the storage status of the returned MessageStreamInfo object.

Source:

data/index.js, line 4142

Returns:

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