org.ajbrown.dropwizard.ssm.config

Class SsmSubstitutor

java.lang.Object

org.apache.commons.text.StrSubstitutor

org.ajbrown.dropwizard.ssm.config.SsmSubstitutor

public class SsmSubstitutor
extends org.apache.commons.text.StrSubstitutor

Uses Amazon Simple Systems manager parameter stores to substitute configuration values.

Field Summary

Fields inherited from class org.apache.commons.text.StrSubstitutor

DEFAULT_ESCAPE, DEFAULT_PREFIX, DEFAULT_SUFFIX, DEFAULT_VALUE_DELIMITER

Constructor Summary

Constructors

Constructor and Description
SsmSubstitutor(com.amazonaws.services.simplesystemsmanagement.AWSSimpleSystemsManagement ssm, boolean strict, boolean substitutionInVariables, String namespacePrefix) Constructor
SsmSubstitutor(com.amazonaws.services.simplesystemsmanagement.AWSSimpleSystemsManagement ssm, boolean strict, String namespacePrefix)
SsmSubstitutor(boolean strict)
SsmSubstitutor(boolean strict, String namespacePrefix)

Method Summary

Methods inherited from class org.apache.commons.text.StrSubstitutor

getEscapeChar, getValueDelimiterMatcher, getVariablePrefixMatcher, getVariableResolver, getVariableSuffixMatcher, isDisableSubstitutionInValues, isEnableSubstitutionInVariables, isPreserveEscapes, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replaceIn, replaceIn, replaceIn, replaceIn, replaceIn, replaceIn, replaceSystemProperties, resolveVariable, setDisableSubstitutionInValues, setEnableSubstitutionInVariables, setEscapeChar, setPreserveEscapes, setValueDelimiter, setValueDelimiter, setValueDelimiterMatcher, setVariablePrefix, setVariablePrefix, setVariablePrefixMatcher, setVariableResolver, setVariableSuffix, setVariableSuffix, setVariableSuffixMatcher, substitute

Methods inherited from class java.lang.Object

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

Constructor Detail

SsmSubstitutor

public SsmSubstitutor(boolean strict)

SsmSubstitutor

public SsmSubstitutor(boolean strict,
                      String namespacePrefix)

SsmSubstitutor

public SsmSubstitutor(@Nonnull
                      com.amazonaws.services.simplesystemsmanagement.AWSSimpleSystemsManagement ssm,
                      boolean strict,
                      String namespacePrefix)

SsmSubstitutor

public SsmSubstitutor(@Nonnull
                      com.amazonaws.services.simplesystemsmanagement.AWSSimpleSystemsManagement ssm,
                      boolean strict,
                      boolean substitutionInVariables,
                      String namespacePrefix)

Constructor

Parameters:

ssm - Amazon SSM client

strict - true if looking up undefined environment variables should throw a UndefinedEnvironmentVariableException, false otherwise.

substitutionInVariables - a flag whether substitution is done in variable names.

namespacePrefix - A prefix to prepend to variable names when determining the parameter key.

Example: if this is set to "foobar/" and you look up the variable "buzz/bar", this SsmLookup will look up the value in a parameter named "foobar/buzz/bar".

This is mostly useful for re-using a variable name across multiple environments

See Also:

EnvironmentVariableLookup.EnvironmentVariableLookup(boolean), StrSubstitutor.setEnableSubstitutionInVariables(boolean)