または PutParameterAWS SDKで を使用する CLI - AWS SDK コード例

AWS Doc SDK Examples GitHub リポジトリには他にも AWS SDK例があります。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

または PutParameterAWS 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/parameter-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/parameter-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/parameter-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/parameter-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/parameter-store-advanced-parameters.html>`__」、および「パラメータポリシーの操作」を参照してください。 AWS

  • API 詳細については、「 コマンドリファレンスPutParameter」の「」を参照してください。 AWS CLI

Java
SDK for Java 2.x
注記

については、「」を参照してください 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
のツール PowerShell

例 1: この例ではパラメータを作成します。コマンドが成功した場合、出力はありません。

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

例 2: この例ではパラメータを変更します。コマンドが成功した場合、出力はありません。

Write-SSMParameter -Name "Welcome" -Type "String" -Value "Good day, Sunshine!" -Overwrite $true
  • API 詳細については、「 コマンドレットリファレンスPutParameter」の「」を参照してください。 AWS Tools for PowerShell

Rust
SDK Rust 用
注記

については、「」を参照してください 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 詳細については、Rust リファレンス のPutParameter「」の「」を参照してください。 AWS SDK API