IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Elastic PostgreSQL connector reference Ingestion APIs »
Elastic Docs › ›Elastic connectors

Elastic S3 connector reference

edit

Elastic S3 connector reference

edit

The Elastic S3 connector is a connector for Amazon S3 data sources.

Availability and prerequisites

edit

This connector is available as a connector client from the Python connectors framework. 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.

Usage

edit

To use this connector as a connector client, use the build a connector workflow. See Connector clients and frameworks.

For additional operations, see Usage.

S3 users will also need to:

Create an IAM identity

edit

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:

  • ListAllMyBuckets
  • ListBucket
  • GetBucketLocation
  • GetObject

Set up AWS CLI

edit

Users need to install the official AWS CLI tool to use this connector as a connector client.

Add the following values:

  • aws_access_key (specifies the AWS identity to be used)
  • aws_secret_key
  • region

Compatibility

edit

Currently the connector does not support S3-compatible vendors.

Configuration

edit

When using the build a connector workflow, these fields will use the default configuration set in the connector source code. These configurable fields will be rendered with their respective labels in the Kibana UI. Once connected, you’ll be able to update these values in Kibana.

The following configuration fields are required to set up the connector:

buckets

List of S3 bucket names. * will fetch data from all buckets. Examples:

  • testbucket, prodbucket
  • testbucket
  • *
read_timeout
The read_timeout for Amazon S3. Default value is 90.
connect_timeout
Connection timeout for crawling S3. Default value is 90.
max_attempts
Maximum retry attempts. Default value is 5.
page_size
Page size for iterating bucket objects in Amazon S3. Default value is 100.
enable_content_extraction

Whether the connector should extract file content from S3. Default value is True, the connector will try to extract file contents.

If enable_content_extraction=False the connector will not attempt to download the content of files in your S3 buckets.

Don’t confuse this with the "Deployment wide content extraction" setting in the Kibana UI. This deployment-wide setting toggles binary content extraction and is powered by ingest pipelines.

Sync rules

edit
  • Files bigger than 10 MB won’t be extracted.
  • Permissions are not synced.
  • Filtering rules are not available in the current version, because filtering is controlled by ingest pipelines.

End-to-end testing

edit

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 DATA_SIZE=small argument:

make ftest NAME=s3 DATA_SIZE=small

Known issues

edit

There are no known issues for this connector.

See Known issues for any issues affecting all connectors.

Troubleshooting

edit

See Troubleshooting.

Security

edit

See Security.

Framework and source

edit

This connector is included in the Python connectors framework.

View the source code for this connector (branch 8.7, compatible with Elastic 8.7).

« Elastic PostgreSQL connector reference Ingestion APIs »