Crear un parámetro Systems Manager (Tools for Windows PowerShell) - AWS Systems Manager

Crear un parámetro Systems Manager (Tools for Windows PowerShell)

Puede utilizar AWS Tools for Windows PowerShell para crear tipos de parámetros String, StringList, y SecureString. Después de eliminar un parámetro, espere al menos 30 segundos para crear un parámetro con el mismo nombre.

Los parámetros no se pueden referenciar ni anidar en los valores de otros parámetros. No puede incluir {{}} o {{ssm:parameter-name}} en el valor de un parámetro.

nota

Los parámetros solo están disponibles en la Región de AWS donde se crearon.

Creación de un parámetro String (Tools for Windows PowerShell)

  1. Instale y configure AWS Tools for PowerShell (Herramientas para Windows PowerShell), si aún no lo ha hecho.

    Para obtener más información, consulte Instalación de AWS Tools for PowerShell.

  2. Ejecute el siguiente comando para crear un parámetro que contenga un valor de texto sin formato. Reemplace cada example resource placeholder con su propia información.

    Write-SSMParameter ` -Name "parameter-name" ` -Value "parameter-value" ` -Type "String"

    -o bien-

    Ejecute el siguiente comando para crear un parámetro que contenga un ID de Amazon Machine Image (AMI) como valor del parámetro.

    nota

    Para crear un parámetro con una etiqueta, cree service.model.tag antes como una variable. A continuación se muestra un ejemplo.

    $tag = New-Object Amazon.SimpleSystemsManagement.Model.Tag $tag.Key = "tag-key" $tag.Value = "tag-value"
    Write-SSMParameter ` -Name "parameter-name" ` -Value "an-AMI-id" ` -Type "String" ` -DataType "aws:ec2:image" ` -Tags $tag

    La opción -DataType solo se debe especificar si va a crear un parámetro que contiene un ID de AMI. Para todos los demás parámetros, el tipo de datos predeterminado es text. Para obtener más información, consulte Compatibilidad con parámetros nativos para los ID de Amazon Machine Image.

    Aquí se incluye un ejemplo que utiliza una jerarquía de parámetros.

    Write-SSMParameter ` -Name "/IAD/Web/SQL/IPaddress" ` -Value "99.99.99.999" ` -Type "String" ` -Tags $tag
  3. Ejecute el siguiente comando para verificar los detalles del parámetro.

    (Get-SSMParameterValue -Name "the-parameter-name-you-specified").Parameters

Creación de un parámetro StringList (Tools for Windows PowerShell)

  1. Instale y configure AWS Tools for PowerShell (Herramientas para Windows PowerShell), si aún no lo ha hecho.

    Para obtener más información, consulte Instalación de AWS Tools for PowerShell.

  2. Ejecute el siguiente comando para crear un parámetro StringList. Reemplace cada example resource placeholder con su propia información.

    nota

    Para crear un parámetro con una etiqueta, cree service.model.tag antes como una variable. A continuación se muestra un ejemplo.

    $tag = New-Object Amazon.SimpleSystemsManagement.Model.Tag $tag.Key = "tag-key" $tag.Value = "tag-value"
    Write-SSMParameter ` -Name "parameter-name" ` -Value "a-comma-separated-list-of-values" ` -Type "StringList" ` -Tags $tag

    Si se ejecuta correctamente, el comando devuelve el número de la versión del parámetro.

    A continuación se muestra un ejemplo.

    Write-SSMParameter ` -Name "stringlist-parameter" ` -Value "Milana,Mariana,Mark,Miguel" ` -Type "StringList" ` -Tags $tag
    nota

    Los elementos de StringList deben ir separados por comas (,). No se puede utilizar otra puntuación ni carácter especial para exceptuar los elementos de la lista. Si tiene un valor de parámetro que requiera una coma, utilice el tipo de datos String.

  3. Ejecute el siguiente comando para verificar los detalles del parámetro.

    (Get-SSMParameterValue -Name "the-parameter-name-you-specified").Parameters

Creación de un parámetro SecureString (Tools for Windows PowerShell)

Antes de crear un parámetro SecureString, obtenga información sobre los requisitos de este tipo de parámetro. Para obtener más información, consulte Creación de un parámetro de cadena segura (AWS CLI).

importante

Solo se cifra el valor de un parámetro SecureString. Los nombres de parámetros, las descripciones y otras propiedades no se cifran.

importante

Parameter Store solo es compatible con claves de cifrado de KMS simétricas. No se puede utilizar una clave de cifrado de KMS asimétrica para cifrar los parámetros. Para obtener ayuda para determinar si una clave de KMS es simétrica o asimétrica, consulte Identificación de claves KMS simétricas y asimétricas en la AWS Key Management ServiceGuía para desarrolladores de .

  1. Instale y configure AWS Tools for PowerShell (Herramientas para Windows PowerShell), si aún no lo ha hecho.

    Para obtener más información, consulte Instalación de AWS Tools for PowerShell.

  2. Para crear un parámetro, ejecute el siguiente comando. Reemplace cada example resource placeholder con su propia información.

    nota

    Para crear un parámetro con una etiqueta, primero cree service.model.tag como una variable. A continuación se muestra un ejemplo.

    $tag = New-Object Amazon.SimpleSystemsManagement.Model.Tag $tag.Key = "tag-key" $tag.Value = "tag-value"
    Write-SSMParameter ` -Name "parameter-name" ` -Value "parameter-value" ` -Type "SecureString" ` -KeyId "an AWS KMS key ID, an AWS KMS key ARN, an alias name, or an alias ARN" ` -Tags $tag

    Si se ejecuta correctamente, el comando devuelve el número de la versión del parámetro.

    nota

    Para utilizar la Clave administrada de AWS asignada a su cuenta, quite el parámetro -KeyId del comando.

    A continuación, se muestra un ejemplo que utiliza un nombre encubierto (3l3vat3131) para un parámetro de contraseña y una Clave administrada de AWS.

    Write-SSMParameter ` -Name "/Finance/Payroll/3l3vat3131" ` -Value "P@sSwW)rd" ` -Type "SecureString"` -Tags $tag
  3. Ejecute el siguiente comando para verificar los detalles del parámetro.

    (Get-SSMParameterValue -Name "the-parameter-name-you-specified" –WithDecryption $true).Parameters

De forma predeterminada, todos SecureString los valores se muestran como texto cifrado. Para descifrar un valor SecureString, un usuario debe tener permisos para llamar a la operación Decrypt de la API de AWS KMS. Para obtener más información acerca de cómo configurar el control de acceso de AWS KMS, consulte Autenticación y control de acceso de AWS KMS en la Guía para desarrolladores de AWS Key Management Service.

importante

Si cambia el alias de clave de KMS para la clave KMS que se utiliza para cifrar un parámetro, también actualice el alias de clave que utiliza el parámetro para hacer referencia a AWS KMS. Esto solo se aplica al alias de clave de KMS; el ID de clave al que se adjunta un alias permanece igual a menos que elimine toda la clave.