Connect to Elasticsearch Using Amazon Web Services Authentication

This applies to: Visual Data Discovery

You can connect the Symphony Elasticsearch connectors to your Elasticsearch data store using Amazon Web Services (AWS) credentials. After connecting, the Symphony Elasticsearch connectors work with AWS Elasticsearch without any restrictions.

AWS does not support Elasticsearch v8.0.

To connect the Elasticsearch connector to your Elasticsearch data store using AWS authentication:

  1. Specify the AWS credentials in a standard AWS-format credentials file (see Format of the credentials file) and store the file in the Elasticsearch connector’s file system.

  2. Edit the Elasticsearch properties file (edc-elasticsearch-6.0.properties or edc-elasticsearch-7.0.properties) and locate or add the elasticsearch.aws.show-aws-connection-params property to the file. This property indicates whether AWS-specific connection parameters should be shown when a new connector is created or the connection properties of an existing connector are refreshed. Valid values are true or false. The default is false (users will not see new AWS connection parameters).

    Set the value of this property to true and save the properties file. For more information about Symphony properties files, read Configuration Property Files.

  3. Create a new Elasticsearch connection or edit an existing one (see Add Data Discovery Data Store Connections).

    The AWS connection parameters appear in the UI. Supply values for them as described in the following table.

    Parameter Specify Description
    AUTHENTICATE_WITH_AWS_CREDENTIALS true

    Indicate whether authentication with AWS credentials should be used. Note that the Elasticsearch username / password specification and AWS credentials cannot be simultaneously used for authentication. Valid values are true or false; the default is false (AWS credentials are not used).
    AWS_REGION a valid region name Specify the AWS region where the target Elasticsearch service is running. This parameter is optional when host names in the connection string have the standard format <domain>.<region>.es.amazonaws.com (the region name can be extracted from the host name). However, when specified, it has priority over the region name included in the host name.
    AWS_PROFILES_CONFIG_PATH the path to the credentials file

    Specify the location of the AWS credentials file in the Elasticsearch connector’s file system. This parameter is optional when the credentials file is in the default location (~/.aws/credentials for the user of the connector).
    AWS_PROFILE a valid profile name in the AWS credentials file

    Specify the profile to use within the AWS credentials file. This parameter is optional if you choose to use the default profile in the AWS credentials file.

  4. After you have specified all parameters necessary for the connection definition, save it. See Add Data Discovery Data Store Connections.