Amazon Kinesis policy

An Amazon Kinesis policy contains the connection details that are used by an Amazon Kinesis Request node when connecting to an Amazon Kinesis application.

You can use an Amazon Kinesis Request node in a message flow to connect IBM® App Connect Enterprise to Amazon Kinesis applications and issue requests to create, retrieve, update, and delete objects such as applications, data streams, data stream records, delivery streams, shards, and tags. The Amazon Kinesis policy controls, at run time, the access to the Amazon Kinesis application.

The Amazon Kinesis policy is created when you configure a connection between an Amazon Kinesis Request node and Amazon Kinesis by using the Connector Discovery wizard. During the process of discovery, account credentials are stored in the vault and connection details are stored in an Amazon Kinesis policy. The policy is created with a type of Amazon Kinesis, and the name of the policy is returned to the Amazon Kinesis Request node and specified in the Connection tab of the node, in the format {policyProjectName}:policyName.

You can also create, update, or delete an Amazon Kinesis policy by using the Manage Discovery Connector Policies and Credentials wizard, which you can access by right-clicking the policy project in the IBM App Connect Enterprise Toolkit and then clicking New > Discovery Connector policies and credentials.

You must deploy this policy before message flows that use the policy are started. If you redeploy an Amazon Kinesis policy, all message flows that are using the policy will be stopped and restarted.

For more information about using Amazon Kinesis policies, see Using Amazon Kinesis with IBM App Connect Enterprise.

Table 1. Properties of the Amazon Kinesis policy.
Property Property name in .policyxml file Description of properties
Amazon Kinesis Application Type applicationType This property is reserved for future use and must be set to the value onprem.
Amazon Kinesis Application Version applicationVersion This property is reserved for future use and must be set to the value v1.
Amazon Kinesis Authentication method authenticationMethod This property is reserved for future use and must be set to the value BASIC.
Region region This property specifies the region of the Amazon Kinesis instance (if any) that you specified in the Region property during connector discovery.
Credential Name credentialName This property specifies the name of the credential that will be used for the connection to Amazon Kinesis.

The specified credential can be defined during connector discovery and stored in the vault. Alternatively, you can specify an existing credential that was configured by using the mqsicredentials command or the server.conf.yaml file, or loaded through an external credential provider.