Package io.jmix.autoconfigure.searchaws

Class SearchAwsProperties

java.lang.Object

io.jmix.autoconfigure.searchaws.SearchAwsProperties

@ConfigurationProperties(prefix="jmix.search.elasticsearch.aws")
@ConstructorBinding
public class SearchAwsProperties
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	accessKey	Access Key of AWS IAM user that is used to access to Elasticsearch service if IAM authentication is enabled.
protected final boolean	iamAuth	Whether AWS IAM user is used to access to Elasticsearch service, false if common base authentication is used.
protected final String	region	AWS Elasticsearch region.
protected final String	secretKey	Secret Key of AWS IAM user that is used to access to Elasticsearch service if IAM authentication is enabled.
protected final String	serviceName	AWS Elasticsearch service name.

Constructor Summary

Constructors

Constructor	Description
SearchAwsProperties(boolean iamAuth, String region, String serviceName, String accessKey, String secretKey)

Method Summary

Modifier and Type	Method	Description
String	getElasticsearchAwsAccessKey()
String	getElasticsearchAwsRegion()
String	getElasticsearchAwsSecretKey()
String	getElasticsearchAwsServiceName()
boolean	isElasticsearchAwsIamAuthentication()

Methods inherited from class java.lang.Object

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

Field Details

iamAuth

protected final boolean iamAuth

Whether AWS IAM user is used to access to Elasticsearch service, false if common base authentication is used.

region

protected final String region

AWS Elasticsearch region. It's used to sign requests if IAM authentication is enabled.

serviceName

protected final String serviceName

AWS Elasticsearch service name. It's used to sign requests if IAM authentication is enabled.

accessKey

protected final String accessKey

Access Key of AWS IAM user that is used to access to Elasticsearch service if IAM authentication is enabled.

secretKey

protected final String secretKey

Secret Key of AWS IAM user that is used to access to Elasticsearch service if IAM authentication is enabled.

Constructor Details

SearchAwsProperties

public SearchAwsProperties(@DefaultValue("true")
 boolean iamAuth,
 String region,
 @DefaultValue("es")
 String serviceName,
 String accessKey,
 String secretKey)

Method Details

isElasticsearchAwsIamAuthentication

public boolean isElasticsearchAwsIamAuthentication()

See Also:

• iamAuth

getElasticsearchAwsRegion

public String getElasticsearchAwsRegion()

See Also:

• region

getElasticsearchAwsServiceName

public String getElasticsearchAwsServiceName()

See Also:

• serviceName

getElasticsearchAwsAccessKey

public String getElasticsearchAwsAccessKey()

See Also:

• accessKey

getElasticsearchAwsSecretKey

public String getElasticsearchAwsSecretKey()

See Also:

• secretKey