Package org.hibernate.search.backend.elasticsearch.aws.cfg

Class ElasticsearchAwsBackendSettings

java.lang.Object

org.hibernate.search.backend.elasticsearch.aws.cfg.ElasticsearchAwsBackendSettings

public final class ElasticsearchAwsBackendSettings
extends Object

AWS-specific configuration properties for Elasticsearch backends.

Constants in this class are to be appended to a prefix to form a property key; see BackendSettings for details.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ElasticsearchAwsBackendSettings.Defaults	Default values for the different settings if no values are given.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CREDENTIALS_ACCESS_KEY_ID	The AWS access key ID when using static credentials.
static final String	CREDENTIALS_SECRET_ACCESS_KEY	The AWS secret access key when using static credentials.
static final String	CREDENTIALS_TYPE	The type of credentials to use when signing is enabled.
static final String	REGION	The AWS region.
static final String	SIGNING_ENABLED	Whether requests should be signed using the AWS credentials.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SIGNING_ENABLED

public static final String SIGNING_ENABLED

Whether requests should be signed using the AWS credentials.

Expects a Boolean value such as true or false, or a string that can be parsed into a Boolean value.

Defaults to ElasticsearchAwsBackendSettings.Defaults.SIGNING_ENABLED.

See Also:

• Constant Field Values

REGION

public static final String REGION

The AWS region.

Expects a String value such as us-east-1.

No default: must be provided when signing is enabled.

See Also:

• Constant Field Values

CREDENTIALS_TYPE

public static final String CREDENTIALS_TYPE

The type of credentials to use when signing is enabled.

Expects one of the names listed as constants in ElasticsearchAwsCredentialsTypeNames.

Defaults to ElasticsearchAwsBackendSettings.Defaults.CREDENTIALS_TYPE.

See Also:

• Constant Field Values

CREDENTIALS_ACCESS_KEY_ID

public static final String CREDENTIALS_ACCESS_KEY_ID

The AWS access key ID when using static credentials.

Expects a String value such as AKIDEXAMPLE.

No default: must be provided when signing is enabled and the credentials type is set to ElasticsearchAwsCredentialsTypeNames.STATIC.

See Also:

• Constant Field Values

CREDENTIALS_SECRET_ACCESS_KEY

public static final String CREDENTIALS_SECRET_ACCESS_KEY

The AWS secret access key when using static credentials.

Expects a String value such as wJalrXUtnFEMI/K7MDENG+bPxRfiCYEXAMPLEKEY

No default: must be provided when signing is enabled and the credentials type is set to ElasticsearchAwsCredentialsTypeNames.STATIC.

See Also:

• Constant Field Values