Uso de PutParameter con un AWS SDK o la CLI

En los siguientes ejemplos de código, se muestra cómo utilizar PutParameter.

CLI

AWS CLI

Ejemplo 1: Cambio del valor de un parámetro

En el siguiente ejemplo de put-parameter se cambia el valor del parámetro especificado.

aws ssm put-parameter \
    --name "MyStringParameter" \
    --type "String" \
    --value "Vici" \
    --overwrite

Salida:

{
    "Version": 2,
    "Tier": "Standard"
}

Para obtener más información, consulte Creación de un parámetro de Systems Manager (AWS CLI), “Administración de niveles de parámetros <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html>`__, y Trabajo con políticas de parámetros en la Guía del usuario de AWS Systems Manager.

Ejemplo 2: Creación de un parámetro avanzado

En el siguiente ejemplo de put-parameter se crea un parámetro avanzado.

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

Salida:

{
    "Version": 1,
    "Tier": "Advanced"
}

Para obtener más información, consulte Creación de un parámetro de Systems Manager (AWS CLI), “Administración de niveles de parámetros <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html>`__, y Trabajo con políticas de parámetros en la Guía del usuario de AWS Systems Manager.

Ejemplo 3: cambio de un parámetro estándar a un parámetro avanzado

En el siguiente ejemplo de put-parameter se convierte un parámetro estándar existente en un parámetro avanzado.

aws ssm put-parameter \
    --name "MyConvertedParameter" \
    --value "abc123" \
    --type "String" \
    --tier Advanced \
    --overwrite

Salida:

{
    "Version": 2,
    "Tier": "Advanced"
}

Para obtener más información, consulte Creación de un parámetro de Systems Manager (AWS CLI), “Administración de niveles de parámetros <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html>`__, y Trabajo con políticas de parámetros en la Guía del usuario de AWS Systems Manager.

Ejemplo 4: creación de un parámetro con una política adjunta

En el siguiente ejemplo de put-parameter se crea un parámetro avanzado con una política de parámetros adjunta.

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\"}}]"

Salida:

{
    "Version": 1,
    "Tier": "Advanced"
}

Para obtener más información, consulte Creación de un parámetro de Systems Manager (AWS CLI), “Administración de niveles de parámetros <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html>`__, y Trabajo con políticas de parámetros en la Guía del usuario de AWS Systems Manager.

Ejemplo 5: adición de una política a un parámetro existente

En el siguiente ejemplo de put-parameter se asocia una política a un parámetro avanzado existente.

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

Salida:

{
    "Version": 2,
    "Tier": "Advanced"
}

Para obtener más información, consulte Creación de un parámetro de Systems Manager (AWS CLI), “Administración de niveles de parámetros <https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html>`__, y Trabajo con políticas de parámetros en la Guía del usuario de AWS Systems Manager.

• Para obtener información acerca de la API, consulte PutParameter en la Referencia de comandos de la AWS CLI.

Java

SDK para Java 2.x

nota

Hay más en GitHub. Busque el ejemplo completo y aprenda a configurar y ejecutar en el Repositorio de ejemplos de código de 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);
        }
    }
}

• Para obtener información sobre la API, consulte PutParameter en la Referencia de la API de AWS SDK for Java 2.x.

PowerShell

Herramientas para PowerShell

Ejemplo 1: en este ejemplo se crea un parámetro. No se obtienen resultados si el comando se ejecuta correctamente.

Write-SSMParameter -Name "Welcome" -Type "String" -Value "helloWorld"

Ejemplo 2: en este ejemplo se modifica un parámetro. No se obtienen resultados si el comando se ejecuta correctamente.

Write-SSMParameter -Name "Welcome" -Type "String" -Value "Good day, Sunshine!" -Overwrite $true

• Para obtener información sobre la API, consulte PutParameter en la Referencia de Cmdlet de Herramientas de AWS para PowerShell.

Rust

SDK para Rust

nota

Hay más en GitHub. Busque el ejemplo completo y aprenda a configurar y ejecutar en el Repositorio de ejemplos de código de 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(())
}

• Para obtener información sobre la API, consulte PutParameter en la Referencia de la API de AWS SDK para Rust.

Para obtener una lista completa de las guías para desarrolladores de AWS SDK y ejemplos de código, consulte Uso de este servicio con un AWS SDK. En este tema también se incluye información sobre cómo comenzar a utilizar el SDK y detalles sobre sus versiones anteriores.