PutKinesisStream

Description:

Sends the contents to a specified Amazon Kinesis. In order to send data to Kinesis, the stream name has to be specified.

Tags:

amazon, aws, kinesis, put, stream

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Amazon Kinesis Stream Namekinesis-stream-nameThe name of Kinesis Stream
Supports Expression Language: true (will be evaluated using flow file attributes and Environment variables)
RegionRegionUS West (Oregon)
  • AWS GovCloud (US-East) AWS Region Code : us-gov-east-1
  • AWS GovCloud (US-West) AWS Region Code : us-gov-west-1
  • Africa (Cape Town) AWS Region Code : af-south-1
  • Asia Pacific (Hong Kong) AWS Region Code : ap-east-1
  • Asia Pacific (Hyderabad) AWS Region Code : ap-south-2
  • Asia Pacific (Jakarta) AWS Region Code : ap-southeast-3
  • Asia Pacific (Melbourne) AWS Region Code : ap-southeast-4
  • Asia Pacific (Mumbai) AWS Region Code : ap-south-1
  • Asia Pacific (Osaka) AWS Region Code : ap-northeast-3
  • Asia Pacific (Seoul) AWS Region Code : ap-northeast-2
  • Asia Pacific (Singapore) AWS Region Code : ap-southeast-1
  • Asia Pacific (Sydney) AWS Region Code : ap-southeast-2
  • Asia Pacific (Tokyo) AWS Region Code : ap-northeast-1
  • Canada (Central) AWS Region Code : ca-central-1
  • Canada West (Calgary) AWS Region Code : ca-west-1
  • China (Beijing) AWS Region Code : cn-north-1
  • China (Ningxia) AWS Region Code : cn-northwest-1
  • Europe (Frankfurt) AWS Region Code : eu-central-1
  • Europe (Ireland) AWS Region Code : eu-west-1
  • Europe (London) AWS Region Code : eu-west-2
  • Europe (Milan) AWS Region Code : eu-south-1
  • Europe (Paris) AWS Region Code : eu-west-3
  • Europe (Spain) AWS Region Code : eu-south-2
  • Europe (Stockholm) AWS Region Code : eu-north-1
  • Europe (Zurich) AWS Region Code : eu-central-2
  • Israel (Tel Aviv) AWS Region Code : il-central-1
  • Middle East (Bahrain) AWS Region Code : me-south-1
  • Middle East (UAE) AWS Region Code : me-central-1
  • South America (Sao Paulo) AWS Region Code : sa-east-1
  • US East (N. Virginia) AWS Region Code : us-east-1
  • US East (Ohio) AWS Region Code : us-east-2
  • US ISO East AWS Region Code : us-iso-east-1
  • US ISO WEST AWS Region Code : us-iso-west-1
  • US ISOB East (Ohio) AWS Region Code : us-isob-east-1
  • US West (N. California) AWS Region Code : us-west-1
  • US West (Oregon) AWS Region Code : us-west-2
  • aws-cn-global AWS Region Code : aws-cn-global
  • aws-global AWS Region Code : aws-global
  • aws-iso-b-global AWS Region Code : aws-iso-b-global
  • aws-iso-global AWS Region Code : aws-iso-global
  • aws-us-gov-global AWS Region Code : aws-us-gov-global
No description provided.
AWS Credentials Provider ServiceAWS Credentials Provider serviceController Service API:
AWSCredentialsProviderService
Implementations: AWSCredentialsProviderControllerService
AWSIDBrokerCloudCredentialsProviderControllerService		The Controller Service that is used to obtain AWS credentials provider
Amazon Kinesis Stream Partition Keyamazon-kinesis-stream-partition-key${kinesis.partition.key}The partition key attribute. If it is not set, a random value is used
Supports Expression Language: true (will be evaluated using flow file attributes and Environment variables)
Message Batch Sizemessage-batch-size250Batch size for messages (1-500).
Max message buffer size (MB)max-message-buffer-size1 MBMax message buffer size in Mega-bytes
Communications TimeoutCommunications Timeout30 secsNo description provided.
Proxy Configuration Serviceproxy-configuration-serviceController Service API:
ProxyConfigurationService
Implementation: StandardProxyConfigurationService		Specifies the Proxy Configuration Controller Service to proxy network requests.
Endpoint Override URLEndpoint Override URLEndpoint URL to use instead of the AWS default including scheme, host, port, and path. The AWS libraries select an endpoint URL based on the AWS region, but this property overrides the selected endpoint URL, allowing use with other S3-compatible endpoints.
Supports Expression Language: true (will be evaluated using Environment variables only)

Relationships:

NameDescription
successFlowFiles are routed to success relationship
failureFlowFiles are routed to failure relationship

Reads Attributes:

None specified.

Writes Attributes:

NameDescription
aws.kinesis.error.messageError message on posting message to AWS Kinesis
aws.kinesis.error.codeError code for the message when posting to AWS Kinesis
aws.kinesis.sequence.numberSequence number for the message when posting to AWS Kinesis
aws.kinesis.shard.idShard id of the message posted to AWS Kinesis

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component requires an incoming relationship.

System Resource Considerations:

None specified.

See Also:

ConsumeKinesisStream