搭PutParameter配 AWS SDK或使用 CLI - AWS SDK 程式碼範例

AWS 文檔 AWS SDK示例 GitHub 回購中有更多SDK示例。

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

搭PutParameter配 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 使用指南」中的「建立系統管理員參數 (AWS CLI)」、「管理參數層 < https://docs.aws.amazon.com/systems-manager/ 最新/使用者指南」/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 使用指南」中的「建立系統管理員參數 (AWS CLI)」、「管理參數層 < https://docs.aws.amazon.com/systems-manager/ 最新/使用者指南」/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 使用指南」中的「建立系統管理員參數 (AWS CLI)」、「管理參數層 < https://docs.aws.amazon.com/systems-manager/ 最新/使用者指南」/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 使用指南」中的「建立系統管理員參數 (AWS CLI)」、「管理參數層 < https://docs.aws.amazon.com/systems-manager/ 最新/使用者指南」/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 使用指南」中的「建立系統管理員參數 (AWS CLI)」、「管理參數層 < https://docs.aws.amazon.com/systems-manager/ 最新/使用者指南」/parameter-store-advanced-parameters.html>`__，以及使用參數原則。AWS

  • 如需詳API細資訊，請參閱AWS CLI 指令參考PutParameter中的。

Java
SDK對於爪哇 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細資訊，請參閱AWS SDK for Java 2.x API參考PutParameter中的。

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細資訊，請參閱AWS Tools for PowerShell 指令程PutParameter式參考中的。

Rust
SDK對於銹
注意

還有更多關於 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 SDK的以取得 Rust API 參考