Availability and prerequisitesedit
This connector is available as a self-managed connector client. This connector client is compatible with Elastic versions 8.6.0+. To use this connector, satisfy all connector client requirements.
This connector is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
To use this connector as a connector client, see Connector clients.
For additional operations, see Using connectors.
S3 users will also need to Create an IAM identity
Create an IAM identityedit
Users need to create an IAM identity to use this connector as a connector client. Refer to the AWS documentation.
The policy associated with the IAM identity must have the following AWS permissions:
Currently the connector does not support S3-compatible vendors.
The following configuration fields are required to set up the connector:
List of S3 bucket names.
*will fetch data from all buckets. Examples:
- Access Key ID for the AWS identity that will be used for bucket access.
- Secret Access Key for the AWS identity that will be used for bucket access.
read_timeoutfor Amazon S3. Default value is
Connection timeout for crawling S3.
Default value is
Maximum retry attempts.
Default value is
Page size for iterating bucket objects in Amazon S3.
Default value is
Deployment using Dockeredit
You can deploy the Amazon S3 connector as a self-managed connector client using Docker. Follow these instructions.
Step 1: Download sample configuration file
Download the sample configuration file. You can either download it manually or run the following command:
curl https://raw.githubusercontent.com/elastic/connectors/main/config.yml --output ~/connectors-config/config.yml
Remember to update the
--output argument value if your directory name is different, or you want to use a different config file name.
Step 2: Update the configuration file for your self-managed connector
Update the configuration file with the following settings to match your environment:
If you’re running the connector service against a Dockerized version of Elasticsearch and Kibana, your config file will look like this:
# When connecting to your cloud deployment you should edit the host value elasticsearch.host: http://host.docker.internal:9200 elasticsearch.api_key: <ELASTICSEARCH_API_KEY> connectors: - connector_id: <CONNECTOR_ID_FROM_KIBANA> service_type: s3 api_key: <CONNECTOR_API_KEY_FROM_KIBANA>
elasticsearch.api_key is the recommended authentication method. However, you can also use
elasticsearch.password to authenticate with your Elasticsearch instance.
Note: You can change other default configurations by simply uncommenting specific settings in the configuration file and modifying their values.
Step 3: Run the Docker image
Run the Docker image with the Connector Service using the following command:
docker run \ -v ~/connectors-config:/config \ --network "elastic" \ --tty \ --rm \ docker.elastic.co/enterprise-search/elastic-connectors:220.127.116.11 \ /app/bin/elastic-ingest \ -c /config/config.yml
DOCKER.md in the
elastic/connectors repo for more details.
Find all available Docker images in the official registry.
Documents and syncsedit
- Files bigger than 10 MB won’t be extracted.
- Permissions are not synced. All documents indexed to an Elastic deployment will be visible to all users with access to that Elastic Deployment.
Basic sync rules are identical for all connectors and are available by default.
Advanced sync rules are not available for this connector in the present version. Currently, filtering is controlled via ingest pipelines.
See Content extraction.
The connector framework enables operators to run functional tests against a real data source. Refer to Connector testing for more details.
To execute a functional test for the Amazon S3 connector client, run the following command:
make ftest NAME=s3
By default, this will use a medium-sized dataset.
To make the test faster add the
make ftest NAME=s3 DATA_SIZE=small
There are no known issues for this connector.
See Known issues for any issues affecting all connectors.
Framework and sourceedit
This connector is included in the Elastic connector framework.
View the source code for this connector (branch 8.11, compatible with Elastic 8.11).