Stores Properties

Usage

All properties can be used and set in initparm and/or sysopts. Any value set in sysopts will override value set in initparm if present.

# IO Exit parameters for Azure

file.ioexit:\
 :name=AZ1:\
 :library=/opt//cdunix/ndm/lib/libcdjnibridge.so:\
 :home.dir=/opt/cdunix/ndm/ioexit-plugins/s3:\
 :options=-Xmx640m \
 -Dstore.providerName=AZ -Dstore.tags=’key1=value1:key2=value2’ \
 -Djava.class.path=/opt /cdunix/ndm/ioexit-plugins/s3/cd-s3-ioexit.jar com.aricent.ibm.mft.connectdirect.s3ioexit.S3IOExitFactory:

Sysopts override in CD process

sysopts=’:store.tags=’key1=AnotherValue:key2=value2’:’

store.tags value overrides value defined in initparm.

Property names are case sensitive when used in initparm but not case sensitive when set in sysopts. 
store.providerName is a java system property name. store.providername will not be retrieved from initparm but will be correctly read from sysopts.

If a property value contains “:” or “=”, value must be enclosed in quotes.

propertyName=’tag=abc:error=true’

General properties

These properties are available for all stores providers. The store.providerName is the most important of them and will trigger the right provider.

Property name (, alternate name for compatibility) Description Possible values Default value
store.providerName Triggers the right store service

S3: Amazon S3

AZ: Azure Blob

GS: Google Storage

COS: IBM Cloud Object Storage

 S3 for compatibility with previous version
store.contentType, s3ioexit.contentType Object Content-Type Free None
store.contentEncoding

Object Content-Encoding

For compatibility with previous version: if *.contentType contains ‘charset’, charset value will be used for Content-Encoding but only if store.contentEncoding is empty

 Free None
store.dwldRange, s3ioexit.dwldRange Size of buffer to read from the provider stream >= 5MB, <= 50MB 5MB
store.objectSize, s3ioexit.objectSize Object size If CD can’t provide it. This value can be used to calculate part size on multi parts uploads.

S3: up to 5TB

AZ: up to 4.78TB

GS: up to 5TB

COS: up to 5TB

 None
store.partSize, s3ioexit.partSize Override to calculated part size

S3: not less than 5MB, up to 5GB

AZ: not less than 64KB, up to 100MB

GS: not less than 5MB, up to 5TB

COS: not less than 5MB, up to 5GB

 None
store.tags Additional info to store with the object as tags or metadata. S

Tags must be enclosed into quotes and separated with semicolon.

store.tags=’key=value;otherKey=abc’

 None

Azure Blob properties (az.*)

Property name (, alternate name for compatibility) Description Possible values Default value
az.connectionString

The connection string includes the full set of info to connect to the service.

Value must be enclosed in quotes.

Example:

az.connectionString=’DefaultEndpointsProtocol=https;AccountName=cduioexit;AccountKey=abcd1r4BIZQlahie2V3cFqTg==;BlobEndpoint=https://cduioexit.blob.core.windows.net/;QueueEndpoint=https://cduioexit.queue.core.windows.net/;TableEndpoint=https://cduioexit.table.core.windows.net/;FileEndpoint=https://cduioexit.file.core.windows.net/’

 None
az.applicationId Additional info application can provide   None
az.accountName Credentials account name   None
az.accountKey Credentials account key   None
az.endpointUrl Endpoint info to override default endpoint. Mainly used when using Azurite (Use Azurite emulator for local Azure Storage development | Microsoft Docs)   None
az.endpointPort Endpoint port   None
az.endpointSecure Endpoint will use https or http YES | NO YES
az.accessTier Object storage class HOT, COOL, ARCHIVE None (inferred from bucket)

Google Storage properties (gs.*)

Property name (, alternate name for compatibility) Description Possible values Default value
gs.credentialsPath Path to the json credentials file   None
gs.projectId Additional info application can provide   None
gs.storageClass Object storage class STANDARD, NEARLINE, COLDLINE, ARCHIVE None (inferred from bucket)

IBM Cloud Object Storage properties (cos.*)

Property name (, alternate name for compatibility) Description Possible values Default value
cos.credentialsPath Path to the json credentials file   None
cos.serviceInstanceId CredentialsService Instance ID   None
cos.apiKey Credentials API key   None
cos.hmacAccessKey AWS S3 credentials hmac access key   None
cos.hmacSecretKey AWS S3 credentials hmac secret key   None
cos.profilePath AWS S3 credential file with hmac keys and profiles   None
cos.profileName AWS S3 credential file with hmac keys, profile name to use Profile names available in credentials file default
cos.endpointUrl Endpoint override   None
cos.endpointPort Endpoint port override   None
cos.endpointSecure Endpoint will use https or http YES, NO YES
cos.location Data Center location: used to dynamically build endpoint (when not overridden by cos.endpoint*) See Locations for resource deployment | IBM Cloud Docs  
cos.endpointType Endpoint Type, used to dynamically build endpoint (when not overridden by cos.endpoint*) DIRECT, PRIVATE, PUBLIC PUBLIC
cos.storageClass Object storage class Accelerated, DeepArchive, Glacier, IntelligentTiering, OneZoneInFrequentAccess, Standard, StandardInFrequentAccess Inferred from bucket
cos.sseS3 Server side encryption requested YES, NO NO
cos.virtualHostedUri

Endpoint format for bucket access, path style access (https://xxx.com/bucket-name/key-name) or virtual hosted (https://bucket-name.xxx.com/key-name)

Only works without endpoint override.

 YES, NO YES

Amazon S3 properties (s3.*)

Property name (, alternate name for compatibility) Description Possible values Default value
s3.accessKey AWS S3 credentials hmac access key   None
s3.secretKey AWS S3 credentials hmac secret key   None
s3.profilePath AWS S3 credential file with hmac keys and profiles   None
s3.configPath AWS S3 credential additional config file   None
s3.profileName AWS S3 credential file with hmac keys, profile name to use Profile names available in merged credentials file and config file default
s3.region AWS region Will be retrieve from profile If not provided None
s3.endpointUrl Endpoint override    
s3.endpointPort Endpoint port override    
s3.endpointSecure Endpoint will use https or http YES, NO YES
s3.storageClass Object storage class Deep_Archive, Glacier, Glacier_IR Intelligent_Tiering, OneZone_IA, Outposts, Reduced_Redundancy, Standard, Standard_IA Inferred from bucket
s3.sseS3 Server side encryption requested with SSE-S3 YES, NO NO
s3.virtualHostedUri

Endpoint format for bucket access, path style access (https://xxx.com/bucket-name/key-name) or virtual hosted (https://bucket-name.xxx.com/key-name)

Only works without endpoint override.

 YES, NO YES