Parameter Store 参考

参数是存储在 Parameter Store 中的任何数据片段，例如文本块、名称列表、AMI ID、商家 ID 或其他配置值。可以在脚本、命令和 SSM 文档中集中引用此数据。

在引用参数时，请使用以下惯例指定参数名称。

{{ssm:parameter-name}}

Parameter Store 支持三种类型的参数：String、StringList 和 SecureString。

有一个例外，当创建或更新参数时，您将以明文形式输入参数值，并且 Parameter Store 不对输入的文本执行验证。但是，对于 String 参数，您可以将数据类型指定为 aws:ec2:image，并且 Parameter Store 会验证您输入的值是否为 Amazon EC2 AMI 的正确格式；例如：ami-12345abcdeEXAMPLE。

参数类型：String

默认情况下，String 参数的值由您输入的任何文本数据块组成。例如：

参数类型：StringList

StringList 参数值包含以逗号分隔的值列表，如下面的示例所示。

Monday,Wednesday,Friday

CSV,TSV,CLF,ELF,JSON

参数类型：SecureString

将 SecureString 用于需要加密的配置值，例如服务端点和账户标识符。对于数据库凭证、API 密钥或令牌等机密，我们建议使用 AWS Secrets Manager，该服务提供专门构建的安全控制措施，包括自动轮换和跨区域复制。

仅会加密参数值。参数名称、描述和其他元数据不会加密。

Parameter Store 使用 AWS KMS 密钥来加密和解密 SecureString 参数值。您可以使用 AWS 托管式密钥 的默认 Parameter Store，也可以使用客户自主管理型密钥。如果需要限定有权解密特定参数的主体，请使用客户自主管理型密钥。有关更多信息，请参阅 使用 AWS KMS 密钥加密和解密参数。

可以将 SecureString 参数与其他 AWS 服务结合使用。以下 Lambda 函数会从 /myapp/dev/vendor/merchant-id 参数中检索加密的商家 ID。该函数会使用该值，但不将其写入函数日志或在响应中返回该值。

import json
import boto3

ssm = boto3.client("ssm", region_name="us-east-1")

def lambda_handler(event, context):
    response = ssm.get_parameter(
        Name="/myapp/dev/vendor/merchant-id",
        WithDecryption=True
    )

    merchant_id = response["Parameter"]["Value"]

    # Use merchant_id when communicating with the vendor system.
    # Don't write the value to logs or include it in the response.

    return {
        "statusCode": 200,
        "body": json.dumps("Vendor configuration retrieved.")
    }

AWS KMS 加密和定价

当您创建 SecureString 参数时，Systems Manager 将使用 AWS KMS 加密参数值。

创建 SecureString 参数不会产生任何 Parameter Store 费用，但使用 AWS KMS 可能会产生费用。有关更多信息，请参阅 AWS Key Management Service 定价。

有关 AWS 托管式密钥和客户管理型密钥的更多信息，请参阅《AWS Key Management Service 开发人员指南》中的 AWS Key Management Service 概念。有关 Parameter Store 如何使用 AWS KMS 的更多信息，请参阅 AWS Systems ManagerParameter Store 如何使用 AWS KMS。

aws kms describe-key \
    --region us-east-1 \
    --key-id alias/aws/ssm

参数名称限制

使用本主题中的信息可在您创建参数时帮助您为参数名称指定有效值。

此信息对《AWS Systems Manager API 参考》中的主题 PutParameter（设置参数） 的详细信息进行了补充，此外，还提供了有关 AllowedPattern、Description、KeyId、Overwrite、Type 和 Value 数值的信息。

参数名称的要求和约束包括：