This version is still in development and is not considered stable yet. For the latest stable version, please use Spring Cloud Config 4.1.4!spring-doc.cn

AWS Parameter Store Backend

Spring Cloud Config Server supports AWS Parameter Store as a backend for configuration properties. You can enable this feature by adding a dependency to the AWS Java SDK for SSM.spring-doc.cn

pom.xml

<dependency>
    <groupId>software.amazon.awssdk</groupId>
    <artifactId>ssm</artifactId>
</dependency>

The following configuration uses the AWS SSM client to access parameters.spring-doc.cn

spring:
  profiles:
    active: awsparamstore
  cloud:
    config:
      server:
        awsparamstore:
          region: eu-west-2
          endpoint: https://ssm.eu-west-2.amazonaws.com
          origin: aws:parameter:
          prefix: /config/service
          profile-separator: _
          recursive: true
          decrypt-values: true
          max-results: 5

The following table describes the AWS Parameter Store configuration properties.spring-doc.cn

Table 1. AWS Parameter Store Configuration Properties
Property Name	Required	Default Value	Remarks
regionspring-doc.cn	nospring-doc.cn		The region to be used by the AWS Parameter Store client. If it’s not explicitly set, the SDK tries to determine the region to use by using the Default Region Provider Chain.spring-doc.cn
endpointspring-doc.cn	nospring-doc.cn		The URL of the entry point for the AWS SSM client. This can be used to specify an alternate endpoint for the API requests.spring-doc.cn
originspring-doc.cn	nospring-doc.cn	`aws:ssm:parameter:`spring-doc.cn	The prefix that is added to the property source’s name to show their provenance.spring-doc.cn
prefixspring-doc.cn	nospring-doc.cn	`/config`spring-doc.cn	Prefix indicating L1 level in the parameter hierarchy for every property loaded from the AWS Parameter Store.spring-doc.cn
profile-separatorspring-doc.cn	nospring-doc.cn	`-`spring-doc.cn	String that separates an appended profile from the context name.spring-doc.cn
recursivespring-doc.cn	nospring-doc.cn	`true`spring-doc.cn	Flag to indicate the retrieval of all AWS parameters within a hierarchy.spring-doc.cn
decrypt-valuesspring-doc.cn	nospring-doc.cn	`true`spring-doc.cn	Flag to indicate the retrieval of all AWS parameters with their value decrypted.spring-doc.cn
max-resultsspring-doc.cn	nospring-doc.cn	`10`spring-doc.cn	The maximum number of items to return for an AWS Parameter Store API call.spring-doc.cn

AWS Parameter Store API credentials are determined using the Default Credential Provider Chain. Versioned parameters are already supported with the default behaviour of returning the latest version.spring-doc.cn

When no application is specified application is the default, and when no profile is specified default is used.spring-doc.cn
Valid values for awsparamstore.prefix must start with a forward slash followed by one or more valid path segments or be empty.spring-doc.cn
Valid values for awsparamstore.profile-separator can only contain dots, dashes and underscores.spring-doc.cn
Valid values for awsparamstore.max-results must be within the [1, 10] range.spring-doc.cn