Amazon S3 Connection Properties
| Field | Required | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| properties | Yes | - | No | Configuration object | |
| region | Yes | - | No | The AWS region where the S3 storage is located. | "us-east-2" |
| useGlobalEndpoint | No | true | No | Set to true to use the global endpoint (if set to false, the connection might fail, depending on the bucket region). | true / false |
| s3StorageClass | Yes | - | Yes | List of storage classes to be retrieved. | [ "Standard", "ReducedRedundancy"] |
| indexContainers | No | false | No | If set to true, folders will be indexed. | true / false |
| scanRecursively | No | true | No | If set to true, discovered items are scanned recursively. | true / false |
| scanExcludedItems | No | false | No | If set to true, scans excluded container items so documents inside them can be processed. | true / false |
| includes | No | [] | Yes | List of regular expressions to match documents to be included in the crawl. | [".*sales.*", ".*finance.*"] |
| excludes | No | [] | Yes | List of regular expressions to match documents to be excluded from the crawl. | [".*food.*", ".*drinks.*"] |
Create example
POST /aspire/_api/connections
{
"type": "s3",
"description": "Amazon S3 Connection Test",
"credential": "5af67012-c59a-44ad-91b5-c1122d963f25",
"properties": {
"region": "us-east-2",
"useGlobalEndpoint": true,
"s3StorageClass": [
"Standard",
"ReducedRedundancy",
"IntelligentTiering",
"StandardInfrequentAccess",
"OneZoneInfrequentAccess",
"Glacier",
"DeepArchive"
],
"indexContainers": false,
"scanRecursively": true,
"scanExcludedItems": false,
"includes": [],
"excludes": []
}
}
Overview
Content Tools
Copyright © 2024 Accenture
