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(value="aws.client.system-manager.parameterstore")
public class AWSParameterStoreConfiguration
extends java.lang.Object
implements io.micronaut.core.util.Toggleable

This is the configuration class for the AWSParameterStoreConfigClient for AWS Parameter Store based configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONFIGURATION_PREFIX The prefix for configuration.
static java.lang.String	ENABLED Constant for whether AWS parameter store is enabled or not.

Constructor Summary

Constructors

Constructor and Description
AWSParameterStoreConfiguration()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getRootHierarchyPath() This is the default for the root hierarchy on the parameter store.
boolean	getUseSecureParameters()
boolean	isEnabled() Enable or disable this feature.
boolean	isSearchActiveEnvironments()
void	setEnabled(boolean enabled) Enable or disable distributed configuration with AWS Parameter Store.
void	setRootHierarchyPath(java.lang.String rootHierarchyPath) The the root hierarchy on the parameter store.
void	setSearchActiveEnvironments(boolean searchActiveEnvironments) Search additional paths suffixed with each active environment.
void	setUseSecureParameters(boolean useSecureParameters) Use auto-decryption via KMS for SecureString parameters.

Methods inherited from class java.lang.Object

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

Field Detail

ENABLED

public static final java.lang.String ENABLED

Constant for whether AWS parameter store is enabled or not.

See Also:

Constant Field Values

CONFIGURATION_PREFIX

public static final java.lang.String CONFIGURATION_PREFIX

The prefix for configuration.

See Also:

Constant Field Values

Constructor Detail

AWSParameterStoreConfiguration

public AWSParameterStoreConfiguration()

Method Detail

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 ().

Parameters:

enabled - enable this feature

getRootHierarchyPath

@NonNull
public java.lang.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
                                 java.lang.String rootHierarchyPath)

The the root hierarchy on the parameter store. Default value ().

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 (). 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 ().

Parameters:

searchActiveEnvironments - True if paths suffixed with micronaut profiles should be searched