PutParameter 搭配 a AWS SDK 或 CLI 使用 - AWS Systems Manager

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

PutParameter 搭配 a AWS SDK 或 CLI 使用

下列程式碼範例示範如何使用 PutParameter

CLI
AWS CLI

範例 1:變更參數值

下列put-parameter範例會變更指定參數的值。

aws ssm put-parameter \ --name "MyStringParameter" \ --type "String" \ --value "Vici" \ --overwrite

輸出:

{ "Version": 2, "Tier": "Standard" }

如需詳細資訊,請參閱 Systems Manager 使用者指南中的建立 Systems Manager 參數 (AWS CLI)、'管理參數層 <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameterWord-store-advanced-parameters.html>`__ 和使用參數政策AWS

範例 2:建立進階參數

下列put-parameter範例會建立進階參數。

aws ssm put-parameter \ --name "MyAdvancedParameter" \ --description "This is an advanced parameter" \ --value "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat [truncated]" \ --type "String" \ --tier Advanced

輸出:

{ "Version": 1, "Tier": "Advanced" }

如需詳細資訊,請參閱 Systems Manager 使用者指南中的建立 Systems Manager 參數 (AWS CLI)、'管理參數層 <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameterWord-store-advanced-parameters.html>`__ 和使用參數政策AWS

範例 3:將標準參數轉換為進階參數

下列put-parameter範例會將現有的標準參數轉換為進階參數。

aws ssm put-parameter \ --name "MyConvertedParameter" \ --value "abc123" \ --type "String" \ --tier Advanced \ --overwrite

輸出:

{ "Version": 2, "Tier": "Advanced" }

如需詳細資訊,請參閱 Systems Manager 使用者指南中的建立 Systems Manager 參數 (AWS CLI)、'管理參數層 <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameterWord-store-advanced-parameters.html>`__ 和使用參數政策AWS

範例 4:建立已連接政策的 參數

下列put-parameter範例會建立附加參數政策的進階參數。

aws ssm put-parameter \ --name "/Finance/Payroll/q2accesskey" \ --value "P@sSwW)rd" \ --type "SecureString" \ --tier Advanced \ --policies "[{\"Type\":\"Expiration\",\"Version\":\"1.0\",\"Attributes\":{\"Timestamp\":\"2020-06-30T00:00:00.000Z\"}},{\"Type\":\"ExpirationNotification\",\"Version\":\"1.0\",\"Attributes\":{\"Before\":\"5\",\"Unit\":\"Days\"}},{\"Type\":\"NoChangeNotification\",\"Version\":\"1.0\",\"Attributes\":{\"After\":\"60\",\"Unit\":\"Days\"}}]"

輸出:

{ "Version": 1, "Tier": "Advanced" }

如需詳細資訊,請參閱 Systems Manager 使用者指南中的建立 Systems Manager 參數 (AWS CLI)、'管理參數層 <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameterWord-store-advanced-parameters.html>`__ 和使用參數政策AWS

範例 5:將政策新增至現有參數

下列put-parameter範例會將政策連接至現有的進階參數。

aws ssm put-parameter \ --name "/Finance/Payroll/q2accesskey" \ --value "N3wP@sSwW)rd" \ --type "SecureString" \ --tier Advanced \ --policies "[{\"Type\":\"Expiration\",\"Version\":\"1.0\",\"Attributes\":{\"Timestamp\":\"2020-06-30T00:00:00.000Z\"}},{\"Type\":\"ExpirationNotification\",\"Version\":\"1.0\",\"Attributes\":{\"Before\":\"5\",\"Unit\":\"Days\"}},{\"Type\":\"NoChangeNotification\",\"Version\":\"1.0\",\"Attributes\":{\"After\":\"60\",\"Unit\":\"Days\"}}]" --overwrite

輸出:

{ "Version": 2, "Tier": "Advanced" }

如需詳細資訊,請參閱 Systems Manager 使用者指南中的建立 Systems Manager 參數 (AWS CLI)、'管理參數層 <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameterWord-store-advanced-parameters.html>`__ 和使用參數政策AWS

  • 如需 API 詳細資訊,請參閱 AWS CLI 命令參考中的 PutParameter

Java
Java 2.x 的 SDK
注意

還有更多 on GitHub。尋找完整範例,並了解如何在 AWS 程式碼範例儲存庫中設定和執行。

import software.amazon.awssdk.regions.Region; import software.amazon.awssdk.services.ssm.SsmClient; import software.amazon.awssdk.services.ssm.model.ParameterType; import software.amazon.awssdk.services.ssm.model.PutParameterRequest; import software.amazon.awssdk.services.ssm.model.SsmException; public class PutParameter { public static void main(String[] args) { final String usage = """ Usage: <paraName> Where: paraName - The name of the parameter. paraValue - The value of the parameter. """; if (args.length != 2) { System.out.println(usage); System.exit(1); } String paraName = args[0]; String paraValue = args[1]; Region region = Region.US_EAST_1; SsmClient ssmClient = SsmClient.builder() .region(region) .build(); putParaValue(ssmClient, paraName, paraValue); ssmClient.close(); } public static void putParaValue(SsmClient ssmClient, String paraName, String value) { try { PutParameterRequest parameterRequest = PutParameterRequest.builder() .name(paraName) .type(ParameterType.STRING) .value(value) .build(); ssmClient.putParameter(parameterRequest); System.out.println("The parameter was successfully added."); } catch (SsmException e) { System.err.println(e.getMessage()); System.exit(1); } } }
  • 如需 API 詳細資訊,請參閱 PutParameter AWS SDK for Java 2.x 參考中的 API

PowerShell
for PowerShell 工具

範例 1:此範例會建立 參數。如果命令成功,則不會輸出。

Write-SSMParameter -Name "Welcome" -Type "String" -Value "helloWorld"

範例 2:此範例會變更 參數。如果命令成功,則不會輸出。

Write-SSMParameter -Name "Welcome" -Type "String" -Value "Good day, Sunshine!" -Overwrite $true
  • 如需 API 詳細資訊,請參閱 AWS Tools for PowerShell Cmdlet 參考中的 PutParameter

Rust
Rust 的 SDK
注意

還有更多 on GitHub。尋找完整範例,並了解如何在 AWS 程式碼範例儲存庫中設定和執行。

async fn make_parameter( client: &Client, name: &str, value: &str, description: &str, ) -> Result<(), Error> { let resp = client .put_parameter() .overwrite(true) .r#type(ParameterType::String) .name(name) .value(value) .description(description) .send() .await?; println!("Success! Parameter now has version: {}", resp.version()); Ok(()) }
  • 如需 API 詳細資訊,請參閱 PutParameter AWS for Rust SDK 參考中的 API

如需 AWS SDK 開發人員指南和程式碼範例的完整清單,請參閱 將此服務與 a AWS SDK 搭配使用。本主題也包含有關入門的資訊,以及先前 SDK 版本的詳細資訊。