Add a Replicat for Amazon Kinesis

Learn to create a Replicat process for an Amazon Kinesis target in OCI GoldenGate.

Before you begin

Before adding and running a Replicat for Amazon Kinesis, ensure that you have the following:

• An Amazon Kinesis connection created and assigned to your target Big Data deployment

• Your Amazon Web Services (AWS) region

Add a Replicat (26ai)

Ensure that you review prerequisites specific to this target type.

To add a Replicat in GoldenGate 26ai:

1. In the OCI GoldenGate deployment console navigation menu, select Replicat.

2. On the Replicat page, select Add Replicat.

3. In the Add Replicat panel, on the Replicat Information page, complete the fields as needed, and then select Next:

   • Select a Replicat Type:

     • Classic Replicat

     • Coordinated Replicat

   • Enter a Process Name, no more than 5 characters long.

   • Enter a Description, to help distinguish this process from others.

4. On the Replicat Options page, complete the fields as needed, and then select Next:

   • Replicat Trail:

     • Enter a Name.

     • Enter a Subdirectory, if you expect the Trail file to be in a location other than the default.

     • Select an Encryption profile. If an encryption profile wasn't created, the Local Wallet is selected by default.

     • For Begin, select the starting point for data processing:

       • Position in Log (default)

       • Now

       • Custom Time

   • Trail Position:

     • Enter the Sequence Number.

     • Enter the RBA Offset.

     • Select your Target from the dropdown.

       Note: Depending on your target selection, you may have additional options to such as Streaming, Stage and Merge, and Staging locations.

   • Target Credentials:

     • Select a Domain.

     • Select an Alias within the specified Domain.

     • Select a Checkpoint Table. Leave the default selection or select the Checkpoint table you created for the target deployment.

     • Select the Max Threads Number (Coordinated Replicats only).

5. On the Managed Options page, complete the optional fields as needed, and then select Next:

   • Select a Profile Name, if one is available.

   • Enable Critical to deployment health.

   • Enable and configure Auto Start settings.

6. On the Parameter File page, you can add parameters to further configure your Replicat. For example:

   table source.table1;

   Note:

   GoldenGate uses Greenwich Mean Time (GMT) by default. Use SETENV to override the default setting for the Replicat. This change doesn’t apply to deployments. For example:

   setenv (TZ="US/Eastern")
   setenv (TZ="GMT+5")

7. On the Properties File page, configure the following Amazon Kinesis properties:

   • gg.eventhandler.kinesis.region: provide the AWS region for the target Amazon Kinesis stream.

   • gg.handler.kinesis.streamMappingTemplate=${tableName}, replace $(tableName} with the name of an existing data stream, leave the default value as is, or use Template Keywords to assign the stream name dynamically.

   • (Optional) gg.handler.kinesis.partitionMappingTemplate=${primaryKeys}, leave the default value as is, or replace ${primaryKeys} with the template name to resolve the message key.

   For information on this target's properties, see Amazon Kinesis in the Oracle GoldenGate for Distributed Applications and Analytics guide.

8. Select Create and Run. If you select Create, then you can manually start the Replicat later from the Replicats page.

Add a Replicat (21c)

1. In the OCI GoldenGate deployment console, on the Administration Service Overview page, select Add Replicat (plus icon).

2. On the Add Replicat page, select a Replicat type, and then select Next.

   The types of Replicats are:

   • Classic Replicat

   • Coordinated Replicat

3. On the Replicat Options page, complete the following fields, and then select Next:

   1. For Process Name, enter a name for the Replicat process.

   2. (Optional) For Description, enter a brief description to distinguish this Replicat from others.

   3. For Trail Name, enter two-character trail name.

   4. For Target, select Amazon Kinesis from the dropdown.

   5. For Available Aliases for Amazon Kinesis, select your alias from the dropdown.

4. On the Parameter File page, add and configure Replicat parameters as needed, and then select Next.

   table source.table1;

   Note:

   GoldenGate uses Greenwich Mean Time (GMT) by default. Use SETENV to override the default setting for the Extract. This change applies only to the Extract process and not the deployment.

   setenv (TZ="US/Eastern")
   setenv (TZ="GMT+5")

5. On the Properties File page, configure the following Amazon Kinesis properties:

   • gg.eventhandler.kinesis.region:: provide the AWS region for the target Amazon Kinesis stream.

   • gg.handler.kinesis.streamMappingTemplate=${tableName}, replace $(tableName} with the name of an existing data stream, leave the default value as is, or use Template Keywords to assign the stream name dynamically.

   • (Optional) gg.handler.kinesis.partitionMappingTemplate=${primaryKeys}, leave the default value as is, or replace ${primaryKeys} with the template name to resolve the message key.

6. Select Create and Run. If you select Create, then you can manually start the Replicat later from the Administration Service Overview page.

You return to the Administration Service Overview page where you can view the creation of the Replicat process and access Replicat Actions.

Related content

• Amazon Kinesis target details