Referencia del Almacén de parámetros

Un parámetro es cualquier dato guardado en el Parameter Store, como un bloque de texto, una lista de nombres, un ID de AMI, un ID de comerciante u otro valor de configuración. Puede hacer referencia a estos datos de forma centralizada en los scripts, comandos y documentos de SSM.

Cuando se hace referencia a un parámetro, se debe especificar el nombre del parámetro mediante la siguiente convención.

{{ssm:parameter-name}}

Parameter Store permite usar tres tipos de parámetros: String, StringList y SecureString.

Con una excepción, cuando cree o actualice un parámetro, deberá ingresar el valor del parámetro como texto sin formato y Parameter Store no realiza ninguna validación en el texto especificado. Sin embargo, para los parámetros String puede especificar el tipo de datos como aws:ec2:image, y Parameter Store valida que el valor ingresado tenga el formato adecuado para una AMI de Amazon EC2; por ejemplo: ami-12345abcdeEXAMPLE.

Tipo de parámetro: String

De forma predeterminada, el valor de un parámetro String consta de cualquier bloque de texto especificado. Por ejemplo:

Tipo de parámetro: StringList

Los valores de los parámetros StringList contienen una lista de valores separados por comas, como se muestra en el siguiente ejemplo.

Monday,Wednesday,Friday

CSV,TSV,CLF,ELF,JSON

Tipo de parámetro: SecuRestring

Utilice SecureString para los valores de configuración que requieren cifrado, como los puntos de conexión del servicio y los identificadores de cuenta. Para los secretos como las credenciales de bases de datos, las claves de API o los tokens, recomendamos AWS Secrets Manager, que proporciona controles de seguridad específicos, como la rotación automática y la replicación entre regiones.

Solo se cifra el valor del parámetro. El nombre, la descripción y el resto de metadatos del parámetro no se cifran.

El Parameter Store cifra y descifra los valores de los parámetros SecureString mediante una clave de AWS KMS. Puede utilizar la Clave administrada de AWS predeterminada para el Parameter Store o una clave administrada por el cliente. Utilice una clave administrada por el cliente si necesita restringir las entidades principales que pueden descifrar determinados parámetros. Para obtener más información, consulte Cifrado y descifrado de parámetros mediante claves de AWS KMS.

Puede usar parámetros SecureString con otros Servicios de AWS. La siguiente función de Lambda recupera un ID de comerciante cifrado del parámetro /myapp/dev/vendor/merchant-id. La función usa el valor sin escribirlo en los registros de la función ni devolverlo en la respuesta.

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 KMSCifrado y precios de

Al crear un parámetro SecureString, Systems Manager utiliza AWS KMS para cifrar el valor del parámetro.

No se aplican cargos del Parameter Store por crear un parámetro SecureString, pero sí pueden aplicarse cargos por utilizar AWS KMS. Para más información, consulte Precios de AWS Key Management Service.

Para obtener más información acerca de las Claves administradas por AWS y de las claves administradas por el cliente, consulte los conceptos de AWS Key Management Service en la Guía para desarrolladores de AWS Key Management Service. Para obtener más información acerca de cómo el Parameter Store utiliza AWS KMS, consulte Cómo el Parameter Store de AWS Systems Manager utiliza AWS KMS.

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

Restricciones de los nombres de parámetros

Utilice la información de este tema como ayuda para especificar los valores válidos de los nombres de los parámetros al crear un parámetro.

Esta información complementa los detalles del tema PutParameter de la Referencia de la API de AWS Systems Manager, que también proporciona información sobre los valores de AllowedPattern, Description, KeyId, Overwrite, Type y Value.

Los nombres de los parámetros deben cumplir los requisitos y restricciones siguientes: