Package io.micronaut.discovery.aws.parameterstore

Class AWSParameterStoreConfiguration

java.lang.Object
io.micronaut.discovery.aws.parameterstore.AWSParameterStoreConfiguration
All Implemented Interfaces:
io.micronaut.core.util.Toggleable
@Requires(env="ec2") @Requires(property="aws.client.system-manager.parameterstore.enabled",value="true",defaultValue="false") @ConfigurationProperties("aws.client.system-manager.parameterstore") public class AWSParameterStoreConfiguration extends Object implements io.micronaut.core.util.Toggleable
This is the configuration class for the AWSParameterStoreConfigClient for AWS Parameter Store based configuration.

  • Field Details

    • ENABLED

      public static final String ENABLED
      Constant for whether AWS parameter store is enabled or not.
      See Also:

    • CONFIGURATION_PREFIX

      public static final String CONFIGURATION_PREFIX
      The prefix for configuration.
      See Also:

  • Constructor Details

    • AWSParameterStoreConfiguration

      public AWSParameterStoreConfiguration()

  • Method Details

    • isEnabled

      public boolean isEnabled()
      Enable or disable this feature.
      Specified by:
      isEnabled in interface io.micronaut.core.util.Toggleable
      Returns:
      enable or disable this feature.

    • setEnabled

      public void setEnabled(boolean enabled)
      Enable or disable distributed configuration with AWS Parameter Store. Default value (false).
      Parameters:
      enabled - enable this feature

    • getRootHierarchyPath

      @NonNull public @NonNull String getRootHierarchyPath()
      This is the default for the root hierarchy on the parameter store.
      Returns:
      root level of parameter hierarchy

    • setRootHierarchyPath

      public void setRootHierarchyPath(@NonNull @NonNull String rootHierarchyPath)
      The the root hierarchy on the parameter store. Default value ("/config/").
      Parameters:
      rootHierarchyPath - root prefix used for all calls to get Parameter store values

    • getUseSecureParameters

      public boolean getUseSecureParameters()
      Returns:
      Use auto encryption on SecureString types

    • setUseSecureParameters

      public void setUseSecureParameters(boolean useSecureParameters)
      Use auto-decryption via KMS for SecureString parameters. Default value (false). If set to false, you will not get unencrypted values.
      Parameters:
      useSecureParameters - True if secure parameters should be used

    • isSearchActiveEnvironments

      public boolean isSearchActiveEnvironments()
      Returns:
      Search active environment paths

    • setSearchActiveEnvironments

      public void setSearchActiveEnvironments(boolean searchActiveEnvironments)
      Search additional paths suffixed with each active environment. e.g. /config/application_EC2 Default value (true).
      Parameters:
      searchActiveEnvironments - True if paths suffixed with micronaut profiles should be searched