PutDynamoDB

Description:

Puts a document from DynamoDB based on hash and range key. The table can have either hash and range or hash key alone. Currently the keys supported are string and number and value can be json document. In case of hash and range keys both key are required for the operation. The FlowFile content must be JSON. FlowFile content is mapped to the specified Json Document attribute in the DynamoDB item.

Tags:

Amazon, DynamoDB, AWS, Put, Insert

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, whether a property supports the NiFi Expression Language, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the nifi.properties file has an entry for the property nifi.sensitive.props.key.

NameDefault ValueAllowable ValuesDescription
Table NameThe DynamoDB table name
Supports Expression Language: true (will be evaluated using variable registry only)
Hash Key NameThe hash key name of the item
Supports Expression Language: true (will be evaluated using variable registry only)
Range Key NameThe range key name of the item
Supports Expression Language: true (will be evaluated using variable registry only)
Hash Key Value${dynamodb.item.hash.key.value}The hash key value of the item
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Range Key Value${dynamodb.item.range.key.value}No Description Provided.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Hash Key Value Typestring
  • string
  • number
The hash key value type of the item
Range Key Value Typestring
  • string
  • number
The range key value type of the item
Json Document attributeThe Json document to be retrieved from the dynamodb item
Supports Expression Language: true (will be evaluated using variable registry only)
Character set of documentUTF-8Character set of data in the document
Supports Expression Language: true (will be evaluated using variable registry only)
Batch items for each request (between 1 and 50)1The items to be retrieved in one batch
Supports Expression Language: true (will be evaluated using variable registry only)
Regionus-west-2
  • AWS GovCloud (US)
  • US East (N. Virginia)
  • US East (Ohio)
  • US West (N. California)
  • US West (Oregon)
  • EU (Ireland)
  • EU (London)
  • EU (Paris)
  • EU (Frankfurt)
  • Asia Pacific (Mumbai)
  • Asia Pacific (Singapore)
  • Asia Pacific (Sydney)
  • Asia Pacific (Tokyo)
  • Asia Pacific (Seoul)
  • South America (Sao Paulo)
  • China (Beijing)
  • China (Ningxia)
  • Canada (Central)
No Description Provided.
Access KeyNo Description Provided.
Sensitive Property: true
Supports Expression Language: true (will be evaluated using variable registry only)
Secret KeyNo Description Provided.
Sensitive Property: true
Supports Expression Language: true (will be evaluated using variable registry only)
Credentials FilePath to a file containing AWS access key and secret key in properties file format.
AWS Credentials Provider serviceController Service API:
AWSCredentialsProviderService
Implementation: AWSCredentialsProviderControllerService
The Controller Service that is used to obtain aws credentials provider
Communications Timeout30 secsNo Description Provided.
SSL Context ServiceController Service API:
SSLContextService
Implementations: StandardRestrictedSSLContextService
StandardSSLContextService
Specifies an optional SSL Context Service that, if provided, will be used to create connections
Proxy Configuration ServiceController Service API:
ProxyConfigurationService
Implementation: StandardProxyConfigurationService
Specifies the Proxy Configuration Controller Service to proxy network requests. If set, it supersedes proxy settings configured per component. Supported proxies: HTTP + AuthN
Proxy HostProxy host name or IP
Supports Expression Language: true (will be evaluated using variable registry only)
Proxy Host PortProxy host port
Supports Expression Language: true (will be evaluated using variable registry only)
Proxy UsernameProxy username
Supports Expression Language: true (undefined scope)
Proxy PasswordProxy password
Sensitive Property: true
Supports Expression Language: true (undefined scope)

Relationships:

NameDescription
unprocessedFlowFiles are routed to unprocessed relationship when DynamoDB is not able to process all the items in the request. Typical reasons are insufficient table throughput capacity and exceeding the maximum bytes per request. Unprocessed FlowFiles can be retried with a new request.
successFlowFiles are routed to success relationship
failureFlowFiles are routed to failure relationship

Reads Attributes:

NameDescription
dynamodb.item.hash.key.valueItems hash key value
dynamodb.item.range.key.valueItems range key value

Writes Attributes:

NameDescription
dynamodb.key.error.unprocessedDynamo db unprocessed keys
dynmodb.range.key.value.errorDynamod db range key error
dynamodb.key.error.not.foundDynamo db key not found
dynamodb.error.exception.messageDynamo db exception message
dynamodb.error.codeDynamo db error code
dynamodb.error.messageDynamo db error message
dynamodb.error.typeDynamo db error type
dynamodb.error.serviceDynamo db error service
dynamodb.error.retryableDynamo db error is retryable
dynamodb.error.request.idDynamo db error request id
dynamodb.error.status.codeDynamo db error status code
dynamodb.item.io.errorIO exception message on creating item

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:

ResourceDescription
MEMORYAn instance of this component can cause high usage of this system resource. Multiple instances or high concurrency settings may result a degradation of performance.

See Also:

DeleteDynamoDB, GetDynamoDB