Class KinesisConfig
- java.lang.Object
-
- org.apache.pinot.plugin.stream.kinesis.KinesisConfig
-
public class KinesisConfig extends Object
Kinesis stream specific config
-
-
Field Summary
Fields Modifier and Type Field Description static StringACCESS_KEYstatic StringASYNC_SESSION_UPDATED_ENABLEDstatic StringDEFAULT_ASYNC_SESSION_UPDATED_ENABLEDstatic StringDEFAULT_IAM_ROLE_BASED_ACCESS_ENABLEDstatic StringDEFAULT_MAX_RECORDSstatic StringDEFAULT_SESSION_DURATION_SECONDSstatic StringDEFAULT_SHARD_ITERATOR_TYPEstatic StringENDPOINTstatic StringEXTERNAL_IDstatic StringIAM_ROLE_BASED_ACCESS_ENABLEDEnable Role based access to AWS.static StringMAX_RECORDS_TO_FETCHstatic StringREGIONstatic StringROLE_ARNstatic StringROLE_SESSION_NAMEstatic StringSECRET_KEYstatic StringSESSION_DURATION_SECONDSstatic StringSHARD_ITERATOR_TYPEstatic StringSTREAM_TYPE
-
Constructor Summary
Constructors Constructor Description KinesisConfig(StreamConfig streamConfig)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetAccessKey()StringgetAwsRegion()StringgetEndpoint()StringgetExternalId()intgetNumMaxRecordsToFetch()StringgetRoleArn()StringgetRoleSessionName()StringgetSecretKey()intgetSessionDurationSeconds()software.amazon.awssdk.services.kinesis.model.ShardIteratorTypegetShardIteratorType()StringgetStreamTopicName()booleanisAsyncSessionUpdateEnabled()booleanisIamRoleBasedAccess()
-
-
-
Field Detail
-
STREAM_TYPE
public static final String STREAM_TYPE
- See Also:
- Constant Field Values
-
SHARD_ITERATOR_TYPE
public static final String SHARD_ITERATOR_TYPE
- See Also:
- Constant Field Values
-
REGION
public static final String REGION
- See Also:
- Constant Field Values
-
ACCESS_KEY
public static final String ACCESS_KEY
- See Also:
- Constant Field Values
-
SECRET_KEY
public static final String SECRET_KEY
- See Also:
- Constant Field Values
-
MAX_RECORDS_TO_FETCH
public static final String MAX_RECORDS_TO_FETCH
- See Also:
- Constant Field Values
-
ENDPOINT
public static final String ENDPOINT
- See Also:
- Constant Field Values
-
IAM_ROLE_BASED_ACCESS_ENABLED
public static final String IAM_ROLE_BASED_ACCESS_ENABLED
Enable Role based access to AWS. iamRoleBasedAccessEnabled - Set it to `true` to enable role based access, default: false roleArn - Required. specify the ARN of the role the client should assume. roleSessionName - session name to be used when creating a role based session. default: pinot-kineis-uuid externalId - string external id value required by role's policy. default: null sessionDurationSeconds - The duration, in seconds, of the role session. Default: 900 asyncSessionUpdateEnabled - Configure whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. Default - `true`- See Also:
- Constant Field Values
-
ROLE_ARN
public static final String ROLE_ARN
- See Also:
- Constant Field Values
-
ROLE_SESSION_NAME
public static final String ROLE_SESSION_NAME
- See Also:
- Constant Field Values
-
EXTERNAL_ID
public static final String EXTERNAL_ID
- See Also:
- Constant Field Values
-
SESSION_DURATION_SECONDS
public static final String SESSION_DURATION_SECONDS
- See Also:
- Constant Field Values
-
ASYNC_SESSION_UPDATED_ENABLED
public static final String ASYNC_SESSION_UPDATED_ENABLED
- See Also:
- Constant Field Values
-
DEFAULT_MAX_RECORDS
public static final String DEFAULT_MAX_RECORDS
- See Also:
- Constant Field Values
-
DEFAULT_SHARD_ITERATOR_TYPE
public static final String DEFAULT_SHARD_ITERATOR_TYPE
-
DEFAULT_IAM_ROLE_BASED_ACCESS_ENABLED
public static final String DEFAULT_IAM_ROLE_BASED_ACCESS_ENABLED
- See Also:
- Constant Field Values
-
DEFAULT_SESSION_DURATION_SECONDS
public static final String DEFAULT_SESSION_DURATION_SECONDS
- See Also:
- Constant Field Values
-
DEFAULT_ASYNC_SESSION_UPDATED_ENABLED
public static final String DEFAULT_ASYNC_SESSION_UPDATED_ENABLED
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
KinesisConfig
public KinesisConfig(StreamConfig streamConfig)
-
-
Method Detail
-
getStreamTopicName
public String getStreamTopicName()
-
getAwsRegion
public String getAwsRegion()
-
getNumMaxRecordsToFetch
public int getNumMaxRecordsToFetch()
-
getShardIteratorType
public software.amazon.awssdk.services.kinesis.model.ShardIteratorType getShardIteratorType()
-
getAccessKey
public String getAccessKey()
-
getSecretKey
public String getSecretKey()
-
getEndpoint
public String getEndpoint()
-
isIamRoleBasedAccess
public boolean isIamRoleBasedAccess()
-
getRoleArn
public String getRoleArn()
-
getRoleSessionName
public String getRoleSessionName()
-
getExternalId
public String getExternalId()
-
getSessionDurationSeconds
public int getSessionDurationSeconds()
-
isAsyncSessionUpdateEnabled
public boolean isAsyncSessionUpdateEnabled()
-
-