Connections > Connection properties > Amazon Kinesis connection properties
  

Amazon Kinesis connection properties

The Amazon Kinesis connection is a messaging connection. Use the Amazon Kinesis connection to access Amazon Kinesis Data Streams or Amazon Kinesis Data Firehose as targets.

Amazon Kinesis Firehose connection properties

When you set up an Amazon Kinesis Firehose connection, you must configure the connection properties.
The following table describes the Amazon Kinesis Firehose connection properties:
Property
Description
Connection Name
Name of the connection.
The name is not case sensitive and must be unique within the domain. You can change this property after you create the connection. The name cannot exceed 128 characters, contain spaces, or contain the following special characters:
~ ` ! $ % ^ & * ( ) - + = { [ } ] | \ : ; " ' < , > . ? /
Description
Optional. Description that you can use to identity the connection.
The description cannot exceed 4,000 characters.
Type
The Amazon Kinesis connection type.
If you do not see the Amazon Kinesis connection type, go to the Add-On Connectors page to enable the connector.
Runtime Environment
Name of the runtime environment where you want to run the tasks.
Service
The type of Kinesis Service that you want to use. Select Kinesis Firehose.
AWS Access Key ID
The access key ID of the Amazon AWS user account.
AWS Secret Access Key
The secret access key for the Amazon AWS user account.
Region
Region where the endpoint for your service is available. You can select one of the following values:
  • - us-east-2. Indicates the US East (Ohio) region.
  • - us-east-1. Indicates the US East (N. Virginia) region.
  • - us-west-1. Indicates the US West (N. California) region.
  • - us-west-2. Indicates the US West (Oregon) region.
  • - ap-northeast-1. Indicates the Asia Pacific (Tokyo) region.
  • - ap-northeast-2. Indicates the Asia Pacific (Seoul) region.
  • - ap-northeast-3. Indicates the Asia Pacific (Osaka-Local) region.
  • - ap-south-1. Indicates the Asia Pacific (Mumbai) region.
  • - ap-southeast-1. Indicates the Asia Pacific (Singapore) region.
  • - ap-southeast-2. Indicates the Asia Pacific (Sydney) region.
  • - ca-central-1. Indicates the Canada (Central) region.
  • - cn-north-1. Indicates the China (Beijing) region.
  • - cn-northwest-1. Indicates the China (Ningxia) region.
  • - eu-central-1. Indicates the EU (Frankfurt) region.
  • - eu-west-1. Indicates the EU (Ireland) region.
  • - eu-west-2. Indicates the EU (London) region.
  • - eu-west-3. Indicates the EU (Paris) region.
  • - sa-east-1. Indicates the South America (São Paulo) region.
  • - us-gov-west-1. Indicates AWS GovCloud (US-West) region.
  • - us-gov-east-1. Indicates AWS GovCloud (US-East) region.
A streaming ingestion task does not support ap-northeast-3 region.
Connection TimeOut (ms)
Optional. Number of milliseconds that the Mass Ingestion service waits to establish a connection to the Kinesis Firehose after which it times out.
Default is 10,000 milliseconds.
Authentication Type
The type of authentication.
Select one of the following values:
  • - AWS Credential Profile
  • - Cross-account IAM Role
Default is AWS Credential Profile.
Cross-account IAM Role is not applicable for a streaming ingestion task.
AWS Credential Profile Name
An AWS credential profile defined in the credentials file.
Required if you use the AWS credential profile authentication type.
A mapping accesses the AWS credentials through the profile name at run time. If you do not provide an AWS credential profile name, the mapping uses the access key ID and secret access key that you specify when you create the connection.
ARN of IAM Role
The Amazon Resource Name specifying the role of an IAM user.
Required if you use the cross-account IAM role authentication type.
Not applicable for a streaming ingestion task.
External ID
The external ID for an IAM role is an additional restriction that you can use in an IAM role trust policy to designate who can assume the IAM role.
Required if you use the cross-account IAM role authentication type and if the external ID is defined by the AWS account.
Not applicable for a streaming ingestion task.

Amazon Kinesis Streams connection properties

When you set up an Amazon Kinesis Streams connection, you must configure the connection properties.
The following table describes the Amazon Kinesis Streams connection properties:
Property
Description
Connection Name
Name of the connection.
The name is not case sensitive and must be unique within the domain. You can change this property after you create the connection. The name cannot exceed 128 characters, contain spaces, or contain the following special characters:
~ ` ! $ % ^ & * ( ) - + = { [ } ] | \ : ; " ' < , > . ? /
Description
Optional. Description that you can use to identity the connection.
The description cannot exceed 4,000 characters.
Type
The Amazon Kinesis connection type.
If you do not see the Amazon Kinesis connection type, go to the Add-On Connectors page to install the connector.
Runtime Environment
Name of the runtime environment where you want to run the tasks.
Service
The type of Kinesis Service that you want to use. Select Kinesis Streams.
AWS Access Key ID
The access key ID of the Amazon AWS user account.
AWS Secret Access Key
The secret access key for your Amazon AWS user account.
Region
Region where the endpoint for your service is available. You can select one of the following values:
  • - us-east-2. Indicates the US East (Ohio) region.
  • - us-east-1. Indicates the US East (N. Virginia) region.
  • - us-west-1. Indicates the US West (N. California) region.
  • - us-west-2. Indicates the US West (Oregon) region.
  • - ap-northeast-1. Indicates the Asia Pacific (Tokyo) region.
  • - ap-northeast-2. Indicates the Asia Pacific (Seoul) region.
  • - ap-northeast-3. Indicates the Asia Pacific (Osaka-Local) region.
  • - ap-south-1. Indicates the Asia Pacific (Mumbai) region.
  • - ap-southeast-1. Indicates the Asia Pacific (Singapore) region.
  • - ap-southeast-2. Indicates the Asia Pacific (Sydney) region.
  • - ca-central-1. Indicates the Canada (Central) region.
  • - cn-north-1. Indicates the China (Beijing) region.
  • - cn-northwest-1. Indicates the China (Ningxia) region.
  • - eu-central-1. Indicates the EU (Frankfurt) region.
  • - eu-west-1. Indicates the EU (Ireland) region.
  • - eu-west-2. Indicates the EU (London) region.
  • - eu-west-3. Indicates the EU (Paris) region.
  • - sa-east-1. Indicates the South America (São Paulo) region.
  • - us-gov-west-1. Indicates AWS GovCloud (US-West) region.
  • - us-gov-east-1. Indicates AWS GovCloud (US-East) region.
A streaming ingestion task does not support ap-northeast-3 region.
Connection TimeOut (ms)
Optional. Number of milliseconds that the Mass Ingestion service waits to establish a connection to the Kinesis Streams after which it times out.
Default is 10,000 milliseconds.
Authentication Type
The type of authentication.
Select one of the following values:
  • - AWS Credential Profile.
  • - Cross-account IAM Role
Default is AWS Credential Profile.
Cross-account IAM Role is not applicable for a streaming ingestion task.
AWS Credential Profile Name
An AWS credential profile defined in the credentials file.
Required if you use the AWS credential profile authentication type.
A mapping accesses the AWS credentials through the profile name at run time. If you do not provide an AWS credential profile name, the mapping uses the access key ID and secret access key that you specify when you create the connection.
ARN of IAM Role
The Amazon Resource Name specifying the role of an IAM user.
Required if you use the cross-account IAM role authentication type.
Not applicable for a streaming ingestion task.
External ID
The external ID for an IAM role is an additional restriction that you can use in an IAM role trust policy to designate who can assume the IAM role.
Required if you use the cross-account IAM role authentication type and if the external ID is defined by the AWS account.
Not applicable for a streaming ingestion task.