Skip to main content
Properties for Amazon S3 connections are specified in the properties object when creating or updating a connection. All properties are nested within the connection request body.

​
Properties

​
region
string
required
AWS region where the S3 bucket is located. Example: us-east-1, ap-south-1, eu-west-1.
​
bucketName
string
required
Name of the S3 bucket to connect to.
​
accessKeyID
string
required
AWS access key ID for authenticating to S3.
​
secretAccessKey
object
required
Reference to a Prophecy secret containing the AWS secret access key.
  • When using the create connection API, the secret must be stored in Prophecy before creating the connection.
  • When using the create fabric API, replace this whole object with the string {{SECRET}}, which references the secret being created in parallel to the connection.
​
kgConfig
object
Knowledge graph configuration settings for the connection. See the Knowledge graph indexer properties for more information.