/n software Adapters for BizTalk
/n software Adapters for BizTalk
Questions / Feedback?

S3 Adapter

Properties   Configuration Settings  

The S3 Adapter provides access to Amazon's Simple Storage Service (S3).

Remarks

The S3 Adapter allows you to access Amazon's Simple Storage Service (S3) securely over an SSL connection. S3 allows you to store arbitrary data in buckets on Amazon's server and access them from anywhere using an Internet connection. Please refer to Amazon S3 documentation> for additional details.

You will first need to sign up for the S3 service and obtain the AccessKey and SecretKey from Amazon. Once you have a valid AccessKey and SecretKey, you may begin uploading/downloading files to and from your buckets.

S3 Receive Adapter

The S3 Receive Adapter will download objects specified by the ObjectMask property contained within the Bucket. The AccessKey and SecretKey properties must be set in order to authenticate with the Amazon server. If you wish to enable SSL, you can turn it on by setting the UseSSL property to true and setting an appropriate SSLCert and SSLAcceptServerCert.

S3 Send Adapter

The S3 Send Adapter requires a Bucket and a ObjectKey to specify the location to upload to. The AccessKey and SecretKey properties must be set in order to authenticate with the Amazon server. If you wish to enable SSL, you can turn it on by setting the UseSSL property to true and setting an appropriate SSLCert and SSLAcceptServerCert.

Please refer to the section on adapter configuration for a description of how to configure receive locations and send ports for this adapter.

Receiver Property List


The following is the full list of the properties of the receiver adapter with short descriptions. Click on the links for further details.

AccessKeyThe Access Key Id for the Amazon Web Services account.
BucketThe name of the current bucket.
DeleteModeControls if and when the remote object is deleted after download.
EncryptionPasswordThe password to use when encrypting the object.
ErrorThresholdThe maximum number of errors before the adapter shuts down.
FirewallA set of properties related to firewall access.
HTTPProxyA set of properties related to proxy access.
MaxBatchSizeThe maximum size, in MB, of the current batch (0 indicates no limit).
MaxFileCountThe maximum number of files in the current batch (0 indicates no limit).
MaxFileSizeThe maximum size, in MB, of a file in the current batch (0 indicates no limit).
MaxThreadsThe maximum number of threads that the adapter may consume.
ObjectMaskIndicates the type of files to download from the S3 server.
OtherDefines a set of configuration settings to be used by the adapter.
PollingIntervalThe amount of time, in seconds, between download attempts.
ReceivedObjectDateThe date of the remote object received by the S3 adapter.
ReceivedObjectNameThe name of the remote object received by the S3 adapter.
ReceivedObjectSizeThe size of the remote object received by the S3 adapter.
RequeueEndpointsWhether to requeue receive endpoints if the polling interval has not been reached.
SecretKeyThe Secret Access Key for the Amazon Web Services account.
SSLAcceptServerCertInstructs the adapter to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to use for client authentication during the SSL handshake.
TempPathA temporary directory where data can be stored before the adapter processes it.
TimeoutA timeout for the adapter.
TransportLogTells the adapter where and how to report information about its operations.
URIThe Uniform Resource Identifier (URI) of the send port or receive location.
UseSSLUse SSL to access Amazon S3.
UseVirtualHostingDetermines which style request to use.

Sender Property List


The following is the full list of the properties of the sender adapter with short descriptions. Click on the links for further details.

AccessKeyThe Access Key Id for the Amazon Web Services account.
AccessPolicyThe AccessPolicy are used to set permissions when an object is updated.
BucketThe name of the current bucket.
ContentDispositionContent disposition for the object.
ContentTypeContent type for the object.
EncryptionPasswordThe password to use when encrypting the object.
FirewallA set of properties related to firewall access.
HTTPProxyA set of properties related to proxy access.
MaxPersistentConnectionsThe maximum number of simultaneous persistent connections when sending.
MaxThreadsThe maximum number of threads that the adapter may consume.
MaxTransmissionBatchSizeThe maximum number of messages that can be sent in a single batch.
ObjectKeyThis is the name of file being uploaded to the server.
OtherDefines a set of configuration settings to be used by the adapter.
SecretKeyThe Secret Access Key for the Amazon Web Services account.
SSLAcceptServerCertInstructs the adapter to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to use for client authentication during the SSL handshake.
TimeoutA timeout for the adapter.
TransmitBatchModeHow the transmitter processes batches.
TransportLogTells the adapter where and how to report information about its operations.
URIThe Uniform Resource Identifier (URI) of the send port or receive location.
UseSSLUse SSL to access Amazon S3.
UseVirtualHostingDetermines which style request to use.

Configuration Settings


The following is a list of configuration settings for the adapter with short descriptions. Click on the links for further details.

DeleteOnSuspendSpecifies whether files may be deleted from server when message is suspended.
IgnoreBucketRestrictionsAllows the user to ignore Amazon-defined bucket name restrictions.
LocationConstraintThe region where buckets will be created.
ObjectDelimiterA delimiter that can be used to roll up a bunch of keys.
ObjectMarkerA marker for the object(s).
ObjectPrefixA prefix for the object(s).
MaxObjectsThe maximum number of objects for the server to return.
ProcessAllPagesWhether or not to continue processing if results are paged.
StorageClassSpecify the storage class to be used for the uploaded object.
URLIf set, the default URL will be overridden by this value.
UseServerSideEncryptionIf true, use server side encryption.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLSecurityFlagsFlags that control certificate verification.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLSNamedGroupsThe supported (EC)DHE groups.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
TcpNoDelayWhether or not to delay when sending packets.
UseInternalSecurityAPITells the adapter whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
/n software Adapters for BizTalk - Version 16.0 [Build 6824]