Skip to main content


         This documentation site is for previous versions. Visit our new documentation site for current releases.      
 

Creating a Kinesis data set

Updated on July 5, 2022

You can create an instance of a Kinesis data set in Pega Platform to connect to an instance of Amazon Kinesis Data Streams. The Amazon Kinesis Data Streams service ingests a large amount of data in real time, durably stores it, and makes it available for lightweight processing.

For Pega Cloud applications, you can use a Pega-provided Kinesis data stream or connect to your own Kinesis data stream.

Before you begin: Make sure that the Identity and Access Management (IAM) policies in Amazon Web Services (AWS) are set to allow access to Kinesis data streams. For more information, see the AWS documentation about IAM policies. To use your own Kinesis account with data streams, change the value of the useExternalKinesisAccount dynamic system setting to true.
  1. In the header of Dev Studio, click CreateData ModelData Set.
  2. On the Create Data Set tab, in the Data Set Record Configuration section, define the following settings to identify your data set:
    1. In the Label field, enter the data set label.Result: The identifier is automatically created based on the data set label.
    2. Optional: To change the automatically created identifier, click Edit, enter an identifier name, and then click OK.
    3. In the Type list, select Kinesis.
  3. In the Context section, specify the application context, applicable class, ruleset, and ruleset version of the data set.
  4. Click Create and open.
  5. In the Connection section, configure the connection to your AWS Kinesis instance:
    Note: This step is not available if your Pega Platform application is hosted in a Pega Cloud environment (the onPegaCloud dynamic system setting is set to true) and you use Pega-provided Kinesis data stream.
    1. In the Kinesis configuration instance, select the AWS authentication profile.
    2. In the Region field, select an AWS region.
      For more information about the available regions, see the AWS documentation.
    Kinesis data set connection settings
    On the Kinesis data set form, the connection settings include the AWS authentication profile and the us east 1 region.
  6. In the Stream section, select a stream that is available in your Kinesis configuration instance.
    Important: If you use a Kinesis data stream with Pega Platform on premises or a Kinesis data stream with Pega Platform in the cloud that are in different regions, you might experience performance issues during data set operations. For optimal performance, use a Kinesis data stream with Pega Platform in the cloud that are in the same region.
  7. Optional: In the Partition key(s) section, define the data set partitioning.
    By configuring partitioning, you ensure that related records are sent to the same partition. If you do not define partition keys, the Kinesis data set randomly assigns records to partitions, which can hinder its performance.
    1. Click Add key.
    2. In the Key field, press the Down Arrow key to select the property that you want the Kinesis data set to use as a partitioning key.
      Note: By default, the available properties to be used as keys correspond to the properties of the Applies To class of the Kinesis data set.
  8. Click Save.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us