AWS Parameter Store 後端

Spring Cloud Config Server 支援 AWS Parameter Store 作為組態屬性的後端。您可以新增對 AWS Java SDK for SSM 的依賴項來啟用此功能。

pom.xml

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

以下組態使用 AWS SSM 用戶端來存取參數。

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

下表說明 AWS Parameter Store 組態屬性。

表 1. AWS Parameter Store 組態屬性
屬性名稱	必要	預設值	備註
region	否		AWS Parameter Store 用戶端要使用的區域。如果未明確設定，SDK 會嘗試使用預設區域供應商鏈來判斷要使用的區域。
endpoint	否		AWS SSM 用戶端進入點的 URL。這可用於為 API 請求指定替代端點。
origin	否	`aws:ssm:parameter`	新增至屬性來源名稱的前綴，以顯示其出處。
prefix	否	`/config`	前綴，指示從 AWS Parameter Store 載入的每個屬性的參數階層中的 L1 層級。
profile-separator	否	`-`	將附加的 profile 與 context 名稱分隔開來的字串。
recursive	否	`true`	旗標，指示擷取階層內的所有 AWS 參數。
decrypt-values	否	`true`	旗標，指示擷取所有已解密值的 AWS 參數。
max-results	否	`10`	AWS Parameter Store API 呼叫要傳回的最大項目數。

AWS Parameter Store API 憑證是使用預設憑證供應商鏈判斷的。版本化參數已經支援，預設行為是傳回最新版本。

未指定應用程式時，application 為預設值，未指定 profile 時，則使用 default。
awsparamstore.prefix 的有效值必須以正斜線開頭，後接一個或多個有效路徑區段，或為空。
awsparamstore.profile-separator 的有效值只能包含點、破折號和底線。
awsparamstore.max-results 的有效值必須在 [1, 10] 範圍內。