Configuration property fixed at build time - All other configuration properties are overridable at runtime

Configuration property

Type

Default

quarkus.hibernate-search-orm.elasticsearch.aws.signing.enabled

quarkus.hibernate-search-orm.elasticsearch."backend-name".aws.signing.enabled

quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".aws.signing.enabled

quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.aws.signing.enabled

Whether requests should be signed using the AWS credentials.

Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_AWS_SIGNING_ENABLED

boolean

false

quarkus.hibernate-search-orm.elasticsearch.aws.region

quarkus.hibernate-search-orm.elasticsearch."backend-name".aws.region

quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".aws.region

quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.aws.region

An Amazon Web Services region that hosts the Elasticsearch service.

Must be provided if signing is enabled; the region won’t be automatically detected.

See software.amazon.awssdk.regions.Region for available regions.

Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_AWS_REGION

Region

quarkus.hibernate-search-orm.elasticsearch.aws.credentials.type

quarkus.hibernate-search-orm.elasticsearch."backend-name".aws.credentials.type

quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".aws.credentials.type

quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.aws.credentials.type

Configure the credentials provider that should be used to authenticate with AWS.

Available values:

  • default - the provider will attempt to identify the credentials automatically using the following checks:

    • Java System Properties - aws.accessKeyId and aws.secretAccessKey

    • Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY

    • Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI

    • Credentials delivered through the Amazon EC2 container service if AWS_CONTAINER_CREDENTIALS_RELATIVE_URI environment variable is set and security manager has permission to access the variable.

    • Instance profile credentials delivered through the Amazon EC2 metadata service

  • static - the provider that uses the access key and secret access key specified in the static-provider section of the config.

  • system-property - it loads credentials from the aws.accessKeyId, aws.secretAccessKey and aws.sessionToken system properties.

  • env-variable - it loads credentials from the AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and AWS_SESSION_TOKEN environment variables.

  • profile - credentials are based on AWS configuration profiles. This loads credentials from a profile file, allowing you to share multiple sets of AWS security credentials between different tools like the AWS SDK for Java and the AWS CLI.

  • container - It loads credentials from a local metadata service. Containers currently supported by the AWS SDK are Amazon Elastic Container Service (ECS) and AWS Greengrass

  • instance-profile - It loads credentials from the Amazon EC2 Instance Metadata Service.

  • process - Credentials are loaded from an external process. This is used to support the credential_process setting in the profile credentials file. See Sourcing Credentials From External Processes for more information.

  • anonymous - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will fail unless the resource or API’s policy has been configured to specifically allow anonymous access.

Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_AWS_CREDENTIALS_TYPE

default, static, system-property, env-variable, profile, container, instance-profile, process, custom, anonymous

default

Default credentials provider configuration

Type

Default

quarkus.hibernate-search-orm.elasticsearch.aws.credentials.default-provider.async-credential-update-enabled

quarkus.hibernate-search-orm.elasticsearch."backend-name".aws.credentials.default-provider.async-credential-update-enabled

quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".aws.credentials.default-provider.async-credential-update-enabled

quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.aws.credentials.default-provider.async-credential-update-enabled

Whether this provider should fetch credentials asynchronously in the background.

If this is true, threads are less likely to block, but additional resources are used to maintain the provider.

Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED

boolean

false

quarkus.hibernate-search-orm.elasticsearch.aws.credentials.default-provider.reuse-last-provider-enabled

quarkus.hibernate-search-orm.elasticsearch."backend-name".aws.credentials.default-provider.reuse-last-provider-enabled

quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".aws.credentials.default-provider.reuse-last-provider-enabled

quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.aws.credentials.default-provider.reuse-last-provider-enabled

Whether the provider should reuse the last successful credentials provider in the chain.

Reusing the last successful credentials provider will typically return credentials faster than searching through the chain.

Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED

boolean

true

Static credentials provider configuration

Type

Default

quarkus.hibernate-search-orm.elasticsearch.aws.credentials.static-provider.access-key-id

quarkus.hibernate-search-orm.elasticsearch."backend-name".aws.credentials.static-provider.access-key-id

quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".aws.credentials.static-provider.access-key-id

quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.aws.credentials.static-provider.access-key-id

AWS Access key id

Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID

string

quarkus.hibernate-search-orm.elasticsearch.aws.credentials.static-provider.secret-access-key

quarkus.hibernate-search-orm.elasticsearch."backend-name".aws.credentials.static-provider.secret-access-key

quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".aws.credentials.static-provider.secret-access-key

quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.aws.credentials.static-provider.secret-access-key

AWS Secret access key

Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY

string

quarkus.hibernate-search-orm.elasticsearch.aws.credentials.static-provider.session-token

quarkus.hibernate-search-orm.elasticsearch."backend-name".aws.credentials.static-provider.session-token

quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".aws.credentials.static-provider.session-token

quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.aws.credentials.static-provider.session-token

AWS Session token

Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN

string

AWS Profile credentials provider configuration

Type

Default

quarkus.hibernate-search-orm.elasticsearch.aws.credentials.profile-provider.profile-name

quarkus.hibernate-search-orm.elasticsearch."backend-name".aws.credentials.profile-provider.profile-name

quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".aws.credentials.profile-provider.profile-name

quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.aws.credentials.profile-provider.profile-name

The name of the profile that should be used by this credentials provider.

If not specified, the value in AWS_PROFILE environment variable or aws.profile system property is used and defaults to default name.

Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME

string

Process credentials provider configuration

Type

Default

quarkus.hibernate-search-orm.elasticsearch.aws.credentials.process-provider.async-credential-update-enabled

quarkus.hibernate-search-orm.elasticsearch."backend-name".aws.credentials.process-provider.async-credential-update-enabled

quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".aws.credentials.process-provider.async-credential-update-enabled

quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.aws.credentials.process-provider.async-credential-update-enabled

Whether the provider should fetch credentials asynchronously in the background.

If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider.

Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED

boolean

false

quarkus.hibernate-search-orm.elasticsearch.aws.credentials.process-provider.credential-refresh-threshold

quarkus.hibernate-search-orm.elasticsearch."backend-name".aws.credentials.process-provider.credential-refresh-threshold

quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".aws.credentials.process-provider.credential-refresh-threshold

quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.aws.credentials.process-provider.credential-refresh-threshold

The amount of time between when the credentials expire and when the credentials should start to be refreshed.

This allows the credentials to be refreshed *before* they are reported to expire.

Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD

Duration

15S

quarkus.hibernate-search-orm.elasticsearch.aws.credentials.process-provider.process-output-limit

quarkus.hibernate-search-orm.elasticsearch."backend-name".aws.credentials.process-provider.process-output-limit

quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".aws.credentials.process-provider.process-output-limit

quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.aws.credentials.process-provider.process-output-limit

The maximum size of the output that can be returned by the external process before an exception is raised.

Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT

MemorySize

1024

quarkus.hibernate-search-orm.elasticsearch.aws.credentials.process-provider.command

quarkus.hibernate-search-orm.elasticsearch."backend-name".aws.credentials.process-provider.command

quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".aws.credentials.process-provider.command

quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.aws.credentials.process-provider.command

The command that should be executed to retrieve credentials.

Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND

string

Custom credentials provider configuration

Type

Default

quarkus.hibernate-search-orm.elasticsearch.aws.credentials.custom-provider.name

quarkus.hibernate-search-orm.elasticsearch."backend-name".aws.credentials.custom-provider.name

quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".aws.credentials.custom-provider.name

quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.aws.credentials.custom-provider.name

The name of custom AwsCredentialsProvider bean.

Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME

string
About the Duration format

To write duration values, use the standard java.time.Duration format. See the Duration#parse() javadoc for more information.

You can also use a simplified format, starting with a number:

  • If the value is only a number, it represents time in seconds.

  • If the value is a number followed by ms, it represents time in milliseconds.

In other cases, the simplified format is translated to the java.time.Duration format for parsing:

  • If the value is a number followed by h, m, or s, it is prefixed with PT.

  • If the value is a number followed by d, it is prefixed with P.
About the MemorySize format

A size configuration option recognises string in this format (shown as a regular expression): [0-9]+[KkMmGgTtPpEeZzYy]?. If no suffix is given, assume bytes.