More About Cloud Storage Adapters
Inbound adapters and outbound adapters both include properties that identify the cloud storage provider and provide the credentials needed to access that provider. Values for these properties can be defined in the Management Portal once the business service or business operation using an adapter has been added to the production. The properties used to connect to the cloud storage provider are:
BucketName (inbound only) — Identifies the cloud storage bucket that contains the blobs you want to work with. When using the outbound adapter, the business operation must define the bucket name property and pass its value to the adapter.
BlobNamePrefix (inbound only) — see Retrieving Blobs.
BlobNamePatter (inbound only) — see Retrieving Blobs.
DeleteAfterDownload (inbound only) — check this box to indicate the blob should be deleted after download.
StorageProvider — Identifies the cloud storage provider.
EndPoint — Identifies a PrivateLink endpoint.
ProviderCredentialsFile— Credentials needed to access the provider. These should be stored securely. Specify the file path for the credentials file.
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:
This needs to be broken down to create a file that looks like:
DefaultEndpointsProtocol=https AccountName=sampleuser AccountKey=5X774mvEs41WxQsOw19PB2Y EndpointSuffix=core.windows.net
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.
The cloud storage adapters were developed using the InterSystems PEX framework, so the ObjectScript source code for the adapter looks different than other adapters. For example, the outbound adapter methods are actually wrappers for methods written in a Java PEX component.