The directives that are processed by the DynamoDB reader are listed below. The suffixes shown are prefixed by the current <ReaderKeyword>_ in a mapping file. By default, the <ReaderKeyword> for the DynamoDB reader is COM.SAFE.FME.DYNAMODB_IN.
REGION
This specifies the region to use when connecting to Amazon Web Services, and will dictate where tables are read from and written to.
Required/Optional
Required
Mapping File Syntax
COM.SAFE.FME.DYNAMODB_IN_REGION US_EAST_1
Workbench Parameter
Region
ACCESS_KEY_ID
Required/Optional: Optional
The AWS Access Key ID of the user who will access the database.
The user must exist with appropriate DynamoDB permissions. If this entry is not found, the access key ID will be searched for in various places. These are, in order:
- a file called AwsCredentials.properties on the Java classpath
- aws.accessKeyId in the Java system properties
- the environment variable AWS_ACCESS_KEY_ID
Once a pair of credentials is found, the search will stop.
Mapping File Syntax
COM.SAFE.FME.DYNAMODB_IN_ACCESS_KEY_ID 022QF06E7MXBSAMPLE
Workbench Parameter
Access Key ID
SECRET_ACCESS_KEY
The secret access key associated with the user accessing the database.
If this parameter is not found, the secret key will be searched for in various places. These are, in order:
- a file called AwsCredentials.properties on the Java classpath
- aws.secretKey in the Java system properties
- the environment variable AWS_SECRET_KEY
Once a pair of credentials is found, the search will stop.
Required/Optional
Optional
Mapping File Syntax
COM.SAFE.FME.DYNAMODB_IN_SECRET_ACCESS_KEY kWcrlUX5JEDGM/SAMPLE/aVmYvHNif5zB+d9+ct
Workbench Parameter
Secret Access Key
DEF
The syntax of the definition is:
COM.SAFE.FME.DYNAMODB_IN_DEF <tableName>
The <tableName> must match a DynamoDB table in the database. This will be used as the feature type of all the features read from the table.
The following example selects rows from the table ROADS, placing the resulting data into FME features with a feature type of ROADS:
COM.SAFE.FME.DYNAMODB_IN_DEF ROADS
Required/Optional
Required
IDs
This optional specification is used to limit the available and defined database tables that will be read. The syntax of the IDs directive is:
COM.SAFE.FME.DYNAMODB_IN_IDs <featureType1> \
<featureType2> \
<featureTypeN>
The feature types must match those used in DEF lines.
The example below selects only the ROADS table for input during a translation:
COM.SAFE.FME.DYNAMODB_IN_IDs ROADS
Required/Optional
Optional
RETRIEVE_ALL_TABLE_NAMES
This parameter is only applicable when generating a mapping file, generating a workspace or when retrieving schemas in an FME Objects application.
When set to yes, and if RETRIEVE_ALL_SCHEMAS is set to no (or missing), names for all of the tables and feature classes in the database are returned. When set to no (or missing), and if RETRIEVE_ALL_SCHEMAS is similarly set to no (or missing), the schemas requested by the IDs directive are returned.
Note: If RETRIEVE_ALL_SCHEMAS is also set to Yes, then RETRIEVE_ALL_SCHEMAS takes precedence.
Required/Optional
Optional
Values
YES | NO (default)
Mapping File Syntax
Not applicable.
FME Objects applications would include RETRIEVE_ALL_TABLE_NAMES followed by “YES” in the parameters array passed to IFMEUniversalReader::open().
Workbench Parameter
Not applicable (used when you browse a Table List)
EXPOSED_ATTRS
This directive allows the selection of format attributes to be explicitly added to the reader feature type.
This is similar to exposing format attributes on a reader feature type once it has been generated; however, it is even more powerful because it enables schema-driven applications other than Workbench to access and leverage these attributes as if they were explicitly on the schema as user attributes.
The result of picking a list of attributes is a comma-separated list of attribute names and types that will be added to the schema features. Currently all reader feature types will receive the same set of additional schema attributes for a given instance of the reader.
Required/Optional
Optional
Mapping File Syntax
Not applicable.
While it is possible for FME Objects applications to invoke this directive, the required format is not documented.
This directive is intended for use in our GUI applications (for example, Workbench) only.
Workbench Parameter
Additional Attributes to Expose