lookupFromAwsS3

Processor that looks up an object from an AWS S3 bucket.

If found, the object becomes the payload, with any desired metadata as the message exchange properties. If the object is not found, processing will stop with an error saying that no object was found in the bucket with the given key.

Properties

Name Summary

forwardProperty()

Adds a property from the object’s metadata to a list to convert into message exchange properties. If an exchange property with the same name already exists, it will be replaced.

bucketName

The storage bucket name the object will be read from. Required.

authenticationConfigKey

A secret key that the server uses to look up the credentials needed to perform the AWS authentication. Required.

endpointUrl

Base URL of the AWS S3 endpoint. Optional.

region

Region name of the bucket. Optional.

retryMaxAttempts

Optional, maximum number of retry attempts the S3 client can perform before failing the request. This option only affects the producer and not the regular flow redelivery mechanism. Defaults to 0, meaning the processor will not perform any retries (though the flow source will still perform retries if configured).

retryInitialDelayMillis

The delay before performing the first retry after the original request has failed. Optional.

retryMaxDelayMillis

Optional, maximum time to wait between retries. An exponential mechanism is used to calculate the next delay between retries.

objectPathExpr

Optional expression used to determine the key of the object to obtain from storage. If this is not set, the payload will be converted to a string and used as the key.

connectionTimeoutMillis

The timeout of the HTTP client socket connection. Optional.

receiveTimeoutMillis

The socket timeout to wait for the first byte of response from the server. Optional.

name

Optional, descriptive name for the processor.

id

Required identifier of the processor, unique across all processors within the flow. Must be between 3 and 30 characters long; contain only lower and uppercase alphabetical characters (a-z and A-Z), numbers, dashes ("-"), and underscores ("_"); and start with an alphabetical character. In other words, it adheres to the regex pattern [a-zA-Z][a-zA-Z0-9_-]{2,29}.

exchangeProperties

Optional set of custom properties in a simple jdk-format, that are added to the message exchange properties before processing the incoming payload. Any existing properties with the same name will be replaced by properties defined here.

retainPayloadOnFailure

Whether the incoming payload is available for error processing on failure. Defaults to false.

Sub-builders

Name Summary

externalSystemDetails

Strategy for describing the external system integration. Optional.

circuitBreakerStrategy

Strategy for configuring the processor’s circuit breaker. Optional.

messageLoggingStrategy

Strategy for describing how a processor’s message is logged on the server.

payloadArchivingStrategy

Strategy for archiving payloads.

inboundTransformationStrategy

Strategy that customizes the conversion of an incoming payload by a processor (e.g., string to object). Should be used when the processor’s default conversion logic cannot be used.

Details

Authentication

The authenticationConfigKey property supports secrets of type AwsCredentials. See the Secret Types documentation for formatting details.