8.4. Configuration Options

region *

AWS Region

The AWS region to access.

string

stream *

Stream Name

The Kinesis stream that you want to access. The Kinesis stream that you specify must already exist.

string

accessKey

Access Key

The access key obtained from AWS.

string

asyncClient

Async Client

If we want a KinesisAsyncClient instance set it to true.

boolean

False

delay

Delay

The number of milliseconds before the next poll of the selected stream.

integer

500

kclDisableCloudwatchMetricsExport

KCL Disable Cloudwatch Metrics Export

Define if we want to use a KCL Consumer and disable the CloudWatch Metrics Export

boolean

False

overrideEndpoint

Endpoint Overwrite

Select this option to override the endpoint URI. To use this option, you must also provide a URI for the uriEndpointOverride option.

boolean

False

profileCredentialsName

Profile Credentials Name

If using a profile credentials provider this parameter sets the profile name.

string

secretKey

Secret Key

The secret key obtained from AWS.

string

sessionToken

Session Token

Amazon AWS Session Token used when the user needs to assume a IAM role.

string

uriEndpointOverride

Overwrite Endpoint URI

The overriding endpoint URI. To use this option, you must also select the overrideEndpoint option.

string

useDefaultCredentialsProvider

Default Credentials Provider

If true, the Kinesis client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key).

boolean

False

useKclConsumers

KCL Consumer

If we want to a KCL Consumer set it to true

boolean

False

useProfileCredentialsProvider

Profile Credentials Provider

Set whether the Kinesis client should expect to load credentials through a profile credentials provider.

boolean

False

useSessionCredentials

Session Credentials

Set whether the Kinesis client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in Kinesis.

boolean

False