Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


REST API Credentials configuration guidelines can be found here.

Amazon S3 Connector's Credentials type must always be specified as "s3".

Properties specific to the Amazon S3 Connector's Credentials are described below.


Easy Heading Free
navigationTitleOn this Page
navigationExpandOptionexpand-all-by-default

Amazon S3 Credentials Properties


FieldRequiredDefaultMultipleNotesExample
propertiesYes-NoConfiguration object
useCredentialsProviderChainNofalseNoIf set to true, it uses the the AWS Credentials Provider Chain. If set to true, accessKey and a secretKey must be specified.true/false
accessKeyNo-NoThe key used to access the Amazon Web Services. Required if useCredentialsProviderChain is false."AKIAQYO33D7WIS4M55NN"
secretKeyNo-NoThe secret key for the specified access key. Required if useCredentialsProviderChain is false."mySecretKey"

Create example


Code Block
themeRDark
titlePOST /aspire/_api/credentials
{
	"type": "s3",
	"description": "S3 Credentials Test",
	"properties": {
		"useCredentialsProviderChain": false,
		"accessKey": "AKIAQYO33D7WIS4M55NN",
		"secretKey": "mySecretKey"
	}
}