Package io.micronaut.opensearch.aws

Class AmazonOpenSearchConfigurationProperties

java.lang.Object
io.micronaut.opensearch.aws.AmazonOpenSearchConfigurationProperties
All Implemented Interfaces:
io.micronaut.core.util.Toggleable, AmazonOpenSearchConfiguration
@ConfigurationProperties("micronaut.opensearch.aws") public class AmazonOpenSearchConfigurationProperties extends Object implements AmazonOpenSearchConfiguration
ConfigurationProperties implementation of AmazonOpenSearchConfiguration.
Since:
1.0.0
Author:
Sergio del Amo

  • Field Details

    • DEFAULT_ENABLED

      public static final boolean DEFAULT_ENABLED
      The default enable value.
      See Also:

    • PREFIX

      public static final String PREFIX
      The prefix to use for Amazon OpenSearch settings.
      See Also:

  • Constructor Details

    • AmazonOpenSearchConfigurationProperties

      public AmazonOpenSearchConfigurationProperties()

  • Method Details

    • isEnabled

      public boolean isEnabled()
      Specified by:
      isEnabled in interface io.micronaut.core.util.Toggleable

    • setEnabled

      public void setEnabled(boolean enabled)
      Whether Amazon OpenSearch Service integration is enabled. Default value true
      Parameters:
      enabled - True if security is enabled

    • getEndpoint

      @Nonnull public String getEndpoint()
      Specified by:
      getEndpoint in interface AmazonOpenSearchConfiguration
      Returns:
      OpenSearch endpoint, without https:// For example: `search-...us-east-1.aoss.amazonaws.com`.

    • setEndpoint

      public void setEndpoint(String endpoint)
      Sets the OpenSearch endpoint, without https:// For example: `search-...us-east-1.aoss.amazonaws.com`.
      Parameters:
      endpoint - OpenSearch endpoint, without https:// For example: `search-...us-east-1.aoss.amazonaws.com`.

    • getSigningRegion

      @Nonnull public software.amazon.awssdk.regions.Region getSigningRegion()
      Specified by:
      getSigningRegion in interface AmazonOpenSearchConfiguration
      Returns:
      The region to use for signing requests.

    • setSigningRegion

      public void setSigningRegion(software.amazon.awssdk.regions.Region signingRegion)
      The region to use for signing requests. For example: `us-east-1`.
      Parameters:
      signingRegion - The region to use for signing requests. For example: Region.US_EAST_1.