Field | Required | Default | Multiple | Notes | Example | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
properties | Yes | - | No | Configuration object | |||||||||
regionserver | Yes | - | No | The AWS region where the S3 storage is locatedAEM repository URL. | " | us-east-2"http://localhost:4502" | |||||||
fetchACL | No | false | useGlobalEndpointNo | Set to true | Noto fetch document ACLs for Pages' Closed User Groups. | true / false | |||||||
useSlash | Yes | false | Yes | Set to true to use | the global endpoint (if set to false, the connection might fail, depending on the bucket region)a "/" at the end of each node path for the .json requests. | true / false | s3StorageClass|||||||
excludeProperties | YesNo | -[ ] | Yes | List of | storage classesproperties to be | retrievedexcluded. | [ | "Standard", { "name": "propertyNameForExclude", "value": "expectedValueForExclude", "regex": false }, { "name": "propertyValueForExcludeWithRegex", "value": "expectedValueForExcludeWithRegex", " | ReducedRedundancy"regex": true } ] | ||||
includeProperties | No | false[ ] | Yes | List of properties to be included. | [ { "name": "propertyNameForInclude1", "value": "expectedValueForInclude1", "regex": false }, { "name": "propertyValueForIncludeWithRegex", "value": "expectedValueForIncludeWithRegex", "regex": true } ] | ||||||||
stopOnScanError | No | true | No | If set to true, folders will be indexed. | true / false | scanRecursively | No | true | NoIf set to true, | discovered items are scanned recursivelythe crawl will stop if there are errors during the scanning phase. | 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.*"] | ||||||||
idleConnectionTimeout | No | 3600000 | No | Maximum time in millisecond to keep a connection open. | 3600000 | ||||||||
maxConnections | No | 100 | No | Maximum number of connections to be opened. | 100 | ||||||||
maxConnectionsPerRoute | No | 10 | No | Maximum number of connections opened for the same target. | 10 | ||||||||
connectionTimeout | No | 15000 | No | Maximum time in milliseconds to wait for the connection. | 15000 | ||||||||
socketTimeout | No | 15000 | No | Maximum time in milliseconds to wait for a socket response. | 15000 | ||||||||
useThrottling | No | false | No | If set to true, enables connection throttling. | true / false | ||||||||
throttlingRate | No | 5000 | No | Time period in milliseconds to throttle the connection. | 5000 | ||||||||
throttlingConnectionRate | No | 500 | No | Maximum number of connections to be used during a throttling period. | 500 | ||||||||
maxRetries | No | 3 | No | Maximum number of retries for a failed document. | 3 | ||||||||
retryWaitTime | No | 5000 | No | Time in millisecond to wait before a retry. | 5000 | ||||||||
useProxy | No | false | No | Set to true to setup a proxy. | true / false | ||||||||
proxyHost | No | - | No | Required if useProxy is set to true. | "localhost" | ||||||||
proxyPort | No | - | No | Required if useProxy is set to true. | "8080" | ||||||||
proxySchema | No | - | No | Required if useProxy is set to true. | "http" | ||||||||
proxyUsername | No | - | No | Required if useProxy is set to true. | "myProxyUser" | ||||||||
proxyPassword | No | - | No | Required if useProxy is set to true. | "encrypted:AEB19E2B31D97E308BF9B3B35EE17ECEF94848249E1BD859D818DB89A6DABEFD" |
Code Block | ||||
---|---|---|---|---|
| ||||
{ "type": "s3adobe-experience", "description": "AmazonAEM S3Test Connection Test", "credential": "5af67012bb4f37ed-c59a1a34-44ad4715-91b5a608-c1122d963f25697b2a2c3601", "properties": { "regionserver": "us-east-2""http://localhost:4502", "fetchACL": false, "useGlobalEndpointuseSlash": truefalse, "s3StorageClassexcludeProperties": [], "includeProperties": [], "StandardstopOnScanError": true, "ReducedRedundancyscanExcludedItems": false, "IntelligentTieringincludes": [], "StandardInfrequentAccessexcludes": [], "OneZoneInfrequentAccessidleConnectionTimeout": 3600000, "GlaciermaxConnections": 100, "DeepArchivemaxConnectionsPerRoute": 10, ]"connectionTimeout": 15000, "indexContainerssocketTimeout": false15000, "scanRecursivelyuseThrottling": truefalse, "scanExcludedItemsmaxRetries": false3, "includesretryWaitTime": []5000, "excludesuseProxy": []false } } |