S3 Tasks

Properties   Configuration Settings  

The S3 Task provides access to Amazon's Simple Storage Service (S3), as well as other S3-like services.

Remarks

The S3 Task allows you to access Amazon's Simple Storage Service (S3), and other S3-like services, securely over an SSL connection. S3 services allow you to store arbitrary data objects in buckets and access them from anywhere using an Internet connection. Please refer to the Amazon S3 documentation (or the documentation for another S3-like service provider) for additional details.

To select which S3 service provider the S3 Task should communicate with, use the ServiceProvider property. Possible values are:

  • spAmazonS3 (0) (default): Amazon S3
  • spDigitalOcean (1): Digital Ocean Spaces
  • spGoogleStorage (2): Google Cloud Storage
  • spWasabi (3): Wasabi
  • spBackblazeB2 (4): Backblaze B2
  • spIBM (7): IBM Cloud Object Storage
  • spOracle (8): Oracle Cloud Object Storage
  • spLinode (9): Linode Object Storage
  • spOther (255): Other Provider

Authentication

You will need to sign up for an account with the desired S3 service and obtain an access key and secret key for it. Once you have a valid access key and secret key, use them to set the AccessKey and SecretKey properties. Once this is done, you may begin uploading/downloading files to and from your buckets.

Note: AccessKey and SecretKey must be set before attempting to use the task, unless ServiceProvider is set to spGoogleStorage (2) and you wish to authenticate using OAuth 2.0; refer to the OAuthAuthorization and GoogleProjectId properties for more information.

S3 Receive Task

The S3 Receive Task will download objects specified by the ObjectMask property contained within the specified Bucket.

S3 Send Task

The S3 Send Task requires a Bucket and a ObjectKey to specify the location to upload files to.

Receiver Property List


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

AccessKeyThe access key to use for authentication.
BucketThe name of the bucket to make requests against.
BucketListString denoting the name of the variable which contains the last bucket listing entries.
EncryptionAlgorithmThe encryption algorithm.
EncryptionPasswordThe encryption password.
FirewallA set of properties related to firewall access.
GoogleProjectIdA Google Cloud Platform project Id string.
HTTPProxyA set of properties related to proxy access.
LocalDirectoryThe directory on the local machine to write downloaded objects to.
LogFileThe file to write logging information to at runtime.
LogModeWhat information gets logged during task execution.
OAuthAuthorizationOAuth Authorization Information.
ObjectDelimiterThe delimiter string to use when listing objects.
ObjectListString denoting the name of the variable which contains the last object listing entries.
ObjectMaskIndicates the type of files to download from the S3 server.
ObjectPrefixA prefix used to restrict the results returned when listing objects.
OperationThe operation which will be executed by the S3 task.
OracleNamespaceThe Oracle Cloud Object Storage namespace string.
OtherDefines a set of configuration settings to be used by the task.
OverwriteWhether or not the task should overwrite files during transfer.
RegionThe region the task will make requests against.
RuntimeLicenseSpecifies the task runtime license key.
SecretKeyThe secret key to use for authentication.
ServiceProviderThe S3 service provider.
SSLAcceptServerCertInstructs the task to unconditionally accept the server certificate that matches the supplied certificate.
SSLAcceptServerCertAcceptAnyTells the task to accept any server certificate.
SSLCertThe certificate to use for client authentication during the SSL handshake.
TimeoutA timeout for the task.
UseSSLWhether to use SSL/TLS when connecting.
UseVirtualHostingDetermines which style request to use.

Sender Property List


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

AccessKeyThe access key to use for authentication.
AccessPolicyThe canned access policy to apply when uploading objects.
BucketThe name of the bucket to make requests against.
ContentDispositionContent disposition to send when uploading objects.
ContentTypeContent type to send when uploading objects.
EncryptionAlgorithmThe encryption algorithm.
EncryptionPasswordThe encryption password.
FirewallA set of properties related to firewall access.
GoogleProjectIdA Google Cloud Platform project Id string.
HTTPProxyA set of properties related to proxy access.
LocalFileThe path to a local file for upload.
LogFileThe file to write logging information to at runtime.
LogModeWhat information gets logged during task execution.
OAuthAuthorizationOAuth Authorization Information.
ObjectKeyThis is the name of file being uploaded to the server.
OracleNamespaceThe Oracle Cloud Object Storage namespace string.
OtherDefines a set of configuration settings to be used by the task.
RegionThe region the task will make requests against.
RuntimeLicenseSpecifies the task runtime license key.
SecretKeyThe secret key to use for authentication.
ServiceProviderThe S3 service provider.
SSLAcceptServerCertInstructs the task to unconditionally accept the server certificate that matches the supplied certificate.
SSLAcceptServerCertAcceptAnyTells the task to accept any server certificate.
SSLCertThe certificate to use for client authentication during the SSL handshake.
TimeoutA timeout for the task.
UseSSLWhether to use SSL/TLS when connecting.
UseVirtualHostingDetermines which style request to use.

Configuration Settings


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

DirDelimiterThe delimiter for subfolders on the S3 server that should not be maintained in the local directory.
IgnoreBucketRestrictionsAllows the user to ignore Amazon-defined bucket name restrictions.
IncludeObjectMD5Includes the MD5 digest of the object data if set.
MaxObjectsThe maximum number of objects for the server to return.
ProcessAllPagesWhether or not to continue processing if results are paged.
SessionTokenThe session token to send in the request when using temporary credentials.
StorageClassSpecify the storage class to be used for the uploaded object.
URLThe URL to use for Other service providers.
UseEC2RoleCredentialsIf set to true, authenticate requests with credentials obtained from the IAM role attached to the EC2 instance.
UseServerSideEncryptionIf true, use server side encryption.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLSecurityFlagsFlags that control certificate verification.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
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 task whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
/n software Tasks for SSIS - Version 20.0 [Build 7877]