Referência do Parameter Store

Um parâmetro é qualquer parte de dados armazenada no Parameter Store, como um bloco de texto, uma lista de nomes, uma senha, um ID de AMI, um ID de comerciante ou outro valor de configuração. Você pode fazer referência a esses dados de forma centralizada em seus scripts, comandos e documentos do SSM.

Ao referenciar um parâmetro, você especifica o nome desse parâmetro usando a seguinte convenção.

{{ssm:parameter-name}}

O Parameter Store fornece suporte a três tipos de parâmetros: String, StringList e SecureString.

Com uma exceção, ao criar ou atualizar um parâmetro, você insere o valor do parâmetro como texto sem formatação, e o Parameter Store não executa nenhuma validação no texto inserido. No entanto, para parâmetros String, você pode especificar o tipo de dados como aws:ec2:image, e o Parameter Store valida se o valor inserido é o formato adequado para uma AMI do Amazon EC2. por exemplo, ami-12345abcdeEXAMPLE.

Tipo de parâmetro: String

Por padrão, o valor de um parâmetro String consiste em qualquer bloco de texto inserido. Por exemplo:

Tipo de parâmetro: StringList

Os valores de parâmetros StringList contêm uma lista de valores separada por vírgulas, conforme mostrado nos exemplos a seguir.

Monday,Wednesday,Friday

CSV,TSV,CLF,ELF,JSON

Tipo de parâmetro: SecureString

Use o SecureString para valores de configuração que exigem criptografia, como endpoints de serviço e identificadores de conta. Para segredos como credenciais de banco de dados, chaves de API ou tokens, recomendamos o AWS Secrets Manager, que fornece controles de segurança específicos, incluindo rotação automática e replicação entre regiões.

Somente o valor de um parâmetro é criptografado. O nome do parâmetro, a descrição e outros metadados não são criptografados.

O Parameter Store criptografa e descriptografa valores de parâmetros SecureString usando uma chave do AWS KMS. Você pode usar a Chave gerenciada pela AWS padrão para o Parameter Store ou uma chave gerenciada pelo cliente. Use uma chave gerenciada pelo cliente quando precisar restringir quais entidades principais podem descriptografar parâmetros específicos. Para obter mais informações, consulte Criptografia e descriptografia de parâmetros usando chaves do AWS KMS.

Você pode usar parâmetros de SecureString com outros Serviços da AWS. A função do Lambda a seguir recupera um ID de comerciante criptografado do parâmetro /myapp/dev/vendor/merchant-id. A função usa o valor sem gravá-lo nos logs da função ou retorná-lo na resposta.

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 KMSCriptografia de definição de preço do

Quando você cria um parâmetro SecureString, o Systems Manager utiliza AWS KMS para criptografar o valor do parâmetro.

Não há cobrança do Parameter Store para criar um parâmetro SecureString, mas as cobranças pelo uso da criptografia do AWS KMS são aplicáveis. Para obter mais informações, consulte Preços do AWS Key Management Service.

Para obter mais informações sobre Chaves gerenciadas pela AWS e chaves gerenciadas pelo cliente, consulte Conceitos do AWS Key Management Service, no Guia do desenvolvedor do AWS Key Management Service. Para obter mais informações sobre como o Parameter Store usa o AWS KMS, consulte Como o AWS Systems ManagerParameter Store usa o AWS KMS.

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

Restrições de nome de parâmetro

Use as informações contidas neste tópico para ajudar você a especificar os valores válidos para os nomes de parâmetro quando você cria um parâmetro.

Essas informações complementam os detalhes no tópico PutParameter na Referência da API do AWS Systems Manager, que também fornece informações sobre os valores AllowedPattern, Description, KeyId, Overwrite, Type e Value.

Os requisitos e restrições para nomes de parâmetros incluem os seguintes: