Elastic S3 connector reference

Elastic S3 connector referenceedit

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

Native connector reference (managed service)edit

View reference for the native connector reference (managed service).

Availability and prerequisitesedit

This connector is available natively in Elastic Cloud as of version 8.12.0. To use this connector, satisfy all native connector requirements.

Create a Amazon S3 connectoredit

Use the UIedit

To create a new Amazon S3 connector:

  1. Navigate to the Search → Connectors page in the Kibana UI.
  2. Follow the instructions to create a new native Amazon S3 connector.

For additional operations, see Using connectors.

Use the APIedit

You can use the Elasticsearch Create connector API to create a new native Amazon S3 connector.

For example:

PUT _connector/<my-s3-connector>
{
  "index_name": "<my-elasticsearch-index>",
  "name": "Content synced from Amazon S3",
  "service_type": "s3",
  "is_native": "true"
}
You’ll also need to create an API key for the connector to use.

The user needs the cluster privileges manage_api_key and write_connector_secrets to generate API keys programmatically.

To create an API key for the connector:

  1. Run the following command, replacing values where indicated. Note the id and encoded return values from the response:

    POST /_security/api_key
    {
      "name": "<connector_name>-connector-api-key",
      "role_descriptors": {
        "<connector_name>-connector-role": {
          "cluster": [
            "monitor"
          ],
          "indices": [
            {
              "names": [
                "<index_name>",
                ".search-acl-filter-<index_name>",
                ".elastic-connectors*"
              ],
              "privileges": [
                "all"
              ],
              "allow_restricted_indices": false
            }
          ]
        }
      }
    }
  2. Use the encoded value to store a connector secret, and note the id return value from this response:

    POST _connector/_secret
    {
      "value": <encoded_api_key>
    }
  3. Use the API key id and the connector secret id to update the connector:

    PUT /_connector/<connector_id>/_api_key_id
    {
      "api_key_id": "<API key id>",
      "api_key_secret_id": "<secret id>"
    }

Refer to the Elasticsearch API documentation for details of all available Connector APIs.

Usageedit

To use this native connector, see Native connectors (managed service).

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:

  • ListAllMyBuckets
  • ListBucket
  • GetBucketLocation
  • GetObject

Compatibilityedit

Currently the connector does not support S3-compatible vendors.

Configurationedit

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

AWS Buckets

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

  • testbucket, prodbucket
  • testbucket
  • *

This field is ignored when using advanced sync rules.

AWS Access Key ID
Access Key ID for the AWS identity that will be used for bucket access.
AWS Secret Key
Secret Access Key for the AWS identity that will be used for bucket access.

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.

Sync rulesedit

Basic sync rules are identical for all connectors and are available by default.

Advanced sync rulesedit

A full sync is required for advanced sync rules to take effect.

Advanced sync rules are defined through a source-specific DSL JSON snippet.

Use advanced sync rules to filter data to be fetched from Amazon S3 buckets. They take the following parameters:

  1. bucket: S3 bucket the rule applies to.
  2. extension (optional): Lists which file types to sync. Defaults to syncing all types.
  3. prefix (optional): String of prefix characters. The connector will fetch file and folder data that matches the string. Defaults to "" (syncs all bucket objects).
Advanced sync rules examplesedit

Fetching files and folders recursively by prefix

Example: Fetch files/folders in folder1/docs.

[
  {
    "bucket": "bucket1",
    "prefix": "folder1/docs"
  }

]

Example: Fetch files/folder starting with folder1.

[
  {
    "bucket": "bucket2",
    "prefix": "folder1"
  }
]

Fetching files and folders by specifying extensions

Example: Fetch all objects which start with abc and then filter using file extensions.

[
  {
    "bucket": "bucket2",
    "prefix": "abc",
    "extension": [".txt", ".png"]
  }
]

Content extractionedit

See Content extraction.

Known issuesedit

There are no known issues for this connector.

See Known issues for any issues affecting all connectors.

Troubleshootingedit

See Troubleshooting.

Securityedit

See Security.

Framework and sourceedit

This connector is built with the Elastic connector framework.

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

Connector client reference (self-managed)edit

View reference for the connector client reference (self-managed).

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.

Create a Amazon S3 connectoredit

Use the UIedit

To create a new Amazon S3 connector:

  1. Navigate to the Search → Connectors page in the Kibana UI.
  2. Follow the instructions to create a new Amazon S3 connector client.

For additional operations, see Using connectors.

Use the APIedit

You can use the Elasticsearch Create connector API to create a new self-managed Amazon S3 connector client.

For example:

PUT _connector/my-s3-connector
{
  "index_name": "my-elasticsearch-index",
  "name": "Content synced from Amazon S3",
  "service_type": "s3"
}
You’ll also need to create an API key for the connector to use.

The user needs the cluster privileges manage_api_key and write_connector_secrets to generate API keys programmatically.

To create an API key for the connector:

  1. Run the following command, replacing values where indicated. Note the encoded return values from the response:

    POST /_security/api_key
    {
      "name": "<connector_name>-connector-api-key",
      "role_descriptors": {
        "<connector_name>-connector-role": {
          "cluster": [
            "monitor"
          ],
          "indices": [
            {
              "names": [
                "<index_name>",
                ".search-acl-filter-<index_name>",
                ".elastic-connectors*"
              ],
              "privileges": [
                "all"
              ],
              "allow_restricted_indices": false
            }
          ]
        }
      }
    }
  2. Update your config.yml file with the API key encoded value.

Refer to the Elasticsearch API documentation for details of all available Connector APIs.

Usageedit

To use this connector as a connector client, see Connector clients (self-managed).

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:

  • ListAllMyBuckets
  • ListBucket
  • GetBucketLocation
  • GetObject

Compatibilityedit

Currently the connector does not support S3-compatible vendors.

Configurationedit

When using the connector client 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
  • *

This field is ignored when using advanced sync rules.

aws_access_key_id
Access Key ID for the AWS identity that will be used for bucket access.
aws_secret_access_key
Secret Access Key for the AWS identity that will be used for bucket access.
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.

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.example --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:

  • elasticsearch.host
  • elasticsearch.api_key
  • connectors

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> # Optional. If not provided, the connector will use the elasticsearch.api_key instead

Using the elasticsearch.api_key is the recommended authentication method. However, you can also use elasticsearch.username and 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:8.13.4.0 \
/app/bin/elastic-ingest \
-c /config/config.yml

Refer to DOCKER.md in the elastic/connectors repo for more details.

Find all available Docker images in the official registry.

We also have a quickstart self-managed option using Docker Compose, so you can spin up all required services at once: Elasticsearch, Kibana, and the connectors service. Refer to this README in the elastic/connectors repo for more information.

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.

Sync rulesedit

Basic sync rules are identical for all connectors and are available by default.

Advanced sync rulesedit

A full sync is required for advanced sync rules to take effect.

Advanced sync rules are defined through a source-specific DSL JSON snippet.

Use advanced sync rules to filter data to be fetched from Amazon S3 buckets. They take the following parameters:

  1. bucket: S3 bucket the rule applies to.
  2. extension (optional): Lists which file types to sync. Defaults to syncing all types.
  3. prefix (optional): String of prefix characters. The connector will fetch file and folder data that matches the string. Defaults to "" (syncs all bucket objects).
Advanced sync rules examplesedit

Fetching files and folders recursively by prefix

Example: Fetch files/folders in folder1/docs.

[
  {
    "bucket": "bucket1",
    "prefix": "folder1/docs"
  }

]

Example: Fetch files/folder starting with folder1.

[
  {
    "bucket": "bucket2",
    "prefix": "folder1"
  }
]

Fetching files and folders by specifying extensions

Example: Fetch all objects which start with abc and then filter using file extensions.

[
  {
    "bucket": "bucket2",
    "prefix": "abc",
    "extension": [".txt", ".png"]
  }
]

Content extractionedit

See Content extraction.

End-to-end testingedit

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 issuesedit

There are no known issues for this connector.

See Known issues for any issues affecting all connectors.

Troubleshootingedit

See Troubleshooting.

Securityedit

See Security.

Framework and sourceedit

This connector is built with the Elastic connector framework.

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