Settings for the Cloud Inbound Adapter

Summary

The cloud inbound adapter has the following settings:

The remaining settings are common to all business services. For information, see Settings for All Business Services.

BucketName

Identifies the cloud storage bucket that contains the blobs you want to work with.

BlobNamePrefix

BlobNamePrefix and BlobNamePattern determine which blobs are retrieved from cloud storage. Looking at an example is the easiest way to understand how these properties work together. Consider an AWS S3 bucket that contains the following blobs:

foo/bar/baz
foo/bar/bash
foo/bar/bang
foo/boo

AWS uses / in blob names to create virtual hierarchies, similar to how a file system organizes files into directories. Within this scheme, the BlobNamePrefix works like a directory name. For example, foo/ chooses all blobs, while foo/bar/ only selects the first three blobs. This selection happens on the AWS server side.

After the client gets a list of blobs from the server, BlobNamePattern is used to filter the list further. For example, if BlobNamePrefix="/foo/bar/" and BlobNamePattern="*ba?", the adapter retrieves just the first blob. This filtering happens on the client side. The BlobNamePattern property supports the wildcards * and ?.

If more than one blob meets the criteria set by BlobNamePrefix and BlobNamePattern, the adapter forwards each blob to the business service individually in separate InboundInput objects.

BlobNamePattern

See BlobNamePrefix.

DeleteAfterDownload

If this setting is enabled, the adapter deletes the blob after downloading it.

StorageProvider

Identifies the cloud storage provider.

EndPoint

PrivateLink endpoint.

ProviderCredentialFile

Credentials needed to access the provider. These should be stored securely.

• AWS — With AWS, you can leave this blank to use the default credential provider chainOpens in a new tab to obtain the credentials needed to access and S3 bucket. If you prefer to use a credentials file, you can download the credentials file from AWS and then specify its file path. See, Sign Up for AWS and Create an IAM UserOpens in a new tab for more details.

• GCP — Create access credentials by following Create and manage service account keysOpens in a new tab.

• Azure — Azure doesn’t support credentials files. It uses a connection string instead, see Configure Azure Storage connection stringsOpens in a new tab for details. The connection string contains key-value pairs delimited by semicolons. The string should be edited to remove the semicolons and each key-value pair placed on its own line.

  A sample connection string looks like:

  DefaultEndpointsProtocol=https;AccountName=sampleuser;AccountKey=5X774mvEs41WxQsOw19PB2Y;EndpointSuffix=core.windows.net
  

  

  This needs to be broken down to create a file that looks like:

  DefaultEndpointsProtocol=https
  AccountName=sampleuser
  AccountKey=5X774mvEs41WxQsOw19PB2Y
  EndpointSuffix=core.windows.net
  

  

StorageRegion

Identifies the region of your cloud storage.

• AWS — For a list of AWS regions, see Amazon Regions, Availability Zones, and Local ZonesOpens in a new tab.

• GCP — For a list of GCP regions, see Bucket LocationsOpens in a new tab.

• Azure — The region is implied in the connection string. No explicit setting is required.