Utilizzo delle etichette di parametro - AWS Systems Manager
Utilizzo delle etichette di parametro (console)Utilizzo delle etichette di parametro (AWS CLI)

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Utilizzo delle etichette di parametro

Un'etichetta di parametro è un alias definito dall'utente che consente di semplificare la gestione delle diverse versioni di un parametro. Quando modificate un parametro, salva AWS Systems Manager automaticamente una nuova versione e incrementa il numero di versione di uno. Un'etichetta può aiutarti a ricordare lo scopo di una versione del parametro in presenza di più versioni.

Ad esempio, supponiamo che tu abbia un parametro chiamato /MyApp/DB/ConnectionString. Il valore del parametro è una stringa di connessione a un server MySQL in un database locale in un ambiente di test. Dopo aver completato l'aggiornamento dell'applicazione, vuoi che il parametro usi una stringa di connessione per un database di produzione. Modifica il valore di /MyApp/DB/ConnectionString. Systems Manager crea automaticamente la versione due con la nuova stringa di connessione. Per aiutarti a ricordare lo scopo di ciascuna versione, puoi associare un'etichetta a ciascun parametro. Alla versione 1 puoi associare l'etichetta Test, mentre alla versione 2 puoi associare l'etichetta Produzione.

Puoi spostare le etichette da una versione di un parametro a un'altra. Ad esempio, se crei la versione 3 del parametro /MyApp/DB/ConnectionString con una stringa di connessione per un nuovo database di produzione, puoi spostare l'etichetta Produzione dalla versione 2 del parametro alla versione 3 del parametro.

Le etichette di parametro sono una valida alternativa ai tag. L'organizzazione potrebbe avere adottato linee guida rigorose per i tag che devono essere applicati alle varie risorse AWS . Al contrario, un'etichetta è una semplice stringa di testo associata a una versione specifica di un parametro.

Analogamente ai tag, puoi eseguire query sui parametri utilizzando le etichette. È possibile visualizzare un elenco di versioni di parametri specifici che utilizzano tutte la stessa etichetta se si esegue una query sul set di parametri utilizzando l'operazione GetParametersByPathAPI, come descritto più avanti in questa sezione.

Nota

Se esegui un comando che specifica una versione di un parametro che non esiste, il comando ha esito negativo. Non torna al valore più recente o predefinito del parametro.

Requisiti e restrizioni relativi alle etichette

Le etichette di parametro sono caratterizzate dalle limitazioni e dai requisiti seguenti:

  • La versione di un parametro può avere un massimo di 10 etichette.

  • Non puoi associare la stessa etichetta a versioni differenti dello stesso parametro. Ad esempio, se la versione 1 del parametro è associata all'etichetta Produzione, non potrai associare l'etichetta Produzione alla versione 2.

  • Puoi spostare un'etichetta da una versione di un parametro a un'altra.

  • Non puoi creare un'etichetta durante la creazione di un parametro. Devi associare un'etichetta a una versione specifica di un parametro.

  • Se non vuoi più utilizzare un'etichetta di parametro, devi spostarla in un'altra versione di un parametro o cancellarla.

  • Un'etichetta può avere una lunghezza massima di 100 caratteri.

  • Le etichette possono contenere lettere (con distinzione tra lettere maiuscole e minuscole), numeri, punti (.), trattini (-) o caratteri di sottolineatura (_).

  • Le etichette non possono iniziare con un numero, "aws" o "ssm" (senza distinzione tra lettere maiuscole e minuscole). Se non è conforme a questi requisiti, un'etichetta non verrà associata alla versione di parametro e verrà visualizzata dal sistema nell'elenco InvalidLabels.

Utilizzo delle etichette di parametro (console)

Questa sezione descrive come eseguire le attività seguenti utilizzando la console di Systems Manager.

Creazione di un'etichetta di parametro (console)

La procedura riportata di seguito illustra come associare un'etichetta a una versione specifica di un parametro esistente utilizzando la console di Systems Manager. Non puoi associare un'etichetta durante la creazione di un parametro.

Associazione di un'etichetta alla versione di un parametro

  1. Apri la AWS Systems Manager console all'indirizzo https://console.aws.amazon.com/systems-manager/.

  2. Nel riquadro di navigazione, scegli Parameter Store.

  3. Scegliere il nome di un parametro per aprire la corrispondente pagina dei dettagli.

  4. Scegliere la scheda History (Cronologia).

  5. Scegliere la versione di parametro alla quale si desidera associare un'etichetta.

  6. Scegliere Gestione delle etichette.

  7. Scegliere Aggiungi nuova etichetta.

  8. Nella casella di testo, inserire il nome dell'etichetta. Per aggiungere altre etichette, scegliere Add new label (Aggiungi una nuova etichetta). È possibile associare un massimo di dieci etichette.

  9. Al termine, scegli Salva le modifiche.

Visualizzazione delle etichette collegate a un parametro (console)

Una versione di parametro può avere un massimo di 10 etichette. La procedura riportata di seguito illustra come visualizzare tutte le etichette associate a una versione di parametro utilizzando la console di Systems Manager.

Visualizzazione delle etichette collegate alla versione di un parametro

  1. Apri la AWS Systems Manager console all'indirizzo https://console.aws.amazon.com/systems-manager/.

  2. Nel riquadro di navigazione, scegli Parameter Store.

  3. Scegliere il nome di un parametro per aprire la corrispondente pagina dei dettagli.

  4. Scegliere la scheda History (Cronologia).

  5. Individuare la versione di parametro per la quale si desidera visualizzare tutte le etichette associate. Nella colonna Labels (Etichette) sono visualizzate tutte le etichette associate a una versione di parametro.

Spostamento di un'etichetta di parametro (console)

La procedura riportata di seguito illustra come spostare un'etichetta di parametro in una versione diversa dello stesso parametro utilizzando la console di Systems Manager.

Spostamento di un'etichetta in una versione di parametro diversa

  1. Apri la AWS Systems Manager console all'indirizzo https://console.aws.amazon.com/systems-manager/.

  2. Nel riquadro di navigazione, scegli Parameter Store.

  3. Scegliere il nome di un parametro per aprire la corrispondente pagina dei dettagli.

  4. Scegliere la scheda History (Cronologia).

  5. Scegliere la versione di parametro per la quale si desidera spostare l'etichetta.

  6. Scegliere Gestione delle etichette.

  7. Scegliere Aggiungi nuova etichetta.

  8. Nella casella di testo, inserire il nome dell'etichetta.

  9. Al termine, scegli Salva le modifiche.

Eliminazione delle etichette di parametro (console)

La procedura riportata di seguito descrive come eliminare una o più etichette di parametri utilizzando la console di Systems Manager.

Eliminazione di etichette da un parametro

  1. Apri la AWS Systems Manager console all'indirizzo https://console.aws.amazon.com/systems-manager/.

  2. Nel riquadro di navigazione, scegli Parameter Store.

  3. Scegliere il nome di un parametro per aprire la corrispondente pagina dei dettagli.

  4. Scegliere la scheda History (Cronologia).

  5. Scegliere la versione di parametro per la quale si desidera eliminare le etichette.

  6. Scegliere Gestione delle etichette.

  7. Scegliere Remove (Rimuovi) accanto a ciascuna etichetta che desideri eliminare.

  8. Al termine, scegli Salva le modifiche.

  9. Conferma che le modifiche siano corrette, inserisci Confirm nella casella di testo e scegli Confirm (Conferma).

Utilizzo delle etichette di parametro (AWS CLI)

Questa sezione descrive come eseguire le attività seguenti utilizzando AWS Command Line Interface (AWS CLI).

Creazione di una nuova etichetta di parametro (AWS CLI)

La procedura riportata di seguito illustra come associare un'etichetta a una versione specifica di un parametro esistente utilizzando AWS CLI. Non puoi associare un'etichetta durante la creazione di un parametro.

Per creare un'etichetta di parametro

  1. Installa e configura AWS Command Line Interface (AWS CLI), se non l'hai già fatto.

    Per informazioni, consulta la pagina Installazione o aggiornamento della versione più recente di AWS CLI.

  2. Eseguire questo comando per visualizzare un elenco dei parametri ai quali si è autorizzati ad associare un'etichetta.

    Nota

    I parametri sono disponibili solo nel Regione AWS luogo in cui sono stati creati. Se il parametro al quale si desidera associare un'etichetta non è disponibile, verificare la regione.

    aws ssm describe-parameters

    Annotare il nome del parametro al quale si desidera associare un'etichetta.

  3. Eseguire questo comando per visualizzare tutte le versioni del parametro.

    aws ssm get-parameter-history --name "parameter-name"

    Annotare la versione di parametro alla quale si desidera associare un'etichetta.

  4. Eseguire questo comando per recuperare le informazioni su un parametro in base al numero di versione.

    aws ssm get-parameters --names "parameter-name:version-number"

    Ecco un esempio.

    aws ssm get-parameters --names "/Production/SQLConnectionString:3"

  5. Eseguire uno di questi comandi per associare un'etichetta a una versione di un parametro. Se si associano più etichette, separare i nomi di etichetta con uno spazio.

    Associazione di un'etichetta alla versione più recente di un parametro

    aws ssm label-parameter-version --name parameter-name  --labels label-name

    Associazione di un'etichetta a una versione specifica di un parametro

    aws ssm label-parameter-version --name parameter-name --parameter-version version-number --labels label-name

    Ecco alcuni esempi.

    aws ssm label-parameter-version --name /config/endpoint --labels production east-region finance
    aws ssm label-parameter-version --name /config/endpoint --parameter-version 3 --labels MySQL-test
    Nota

    Se l'output mostra l'etichetta creata nell'elenco InvalidLabels, significa che l'etichetta non è conforme ai requisiti descritti più indietro in questo argomento. Esaminare i requisiti e riprovare. Se l'elenco InvalidLabels è vuoto, significa che l'etichetta è stata correttamente applicata alla versione del parametro.

  6. È possibile visualizzare i dettagli del parametro utilizzando il numero di versione o il nome dell'etichetta. Eseguire questo comando e specificare l'etichetta creata nella fase precedente.

    aws ssm get-parameter --name parameter-name:label-name --with-decryption

    Il comando restituisce informazioni simili alle seguenti.

    {
    "Parameter": {
        "Version": version-number, 
        "Type": "parameter-type", 
        "Name": "parameter-name", 
        "Value": "parameter-value", 
        "Selector": ":label-name"
    }
}
    Nota

    Il valore di Selector nell'output rappresenta il numero di versione o l'etichetta specificata nel campo di input Name.

Visualizzazione delle etichette per un parametro (AWS CLI)

È possibile utilizzare l'operazione GetParameterHistoryAPI per visualizzare la cronologia completa e tutte le etichette allegate a un parametro specificato. In alternativa, è possibile utilizzare l'operazione GetParametersByPathAPI per visualizzare un elenco di tutti i parametri a cui è assegnata un'etichetta specifica.

Per visualizzare le etichette per un parametro utilizzando l'operazione GetParameterHistory API

  1. Eseguire questo comando per visualizzare un elenco dei parametri per i quali è possibile visualizzare le etichette.

    Nota

    I parametri sono disponibili solo nella regione in cui sono stati creati. Se il parametro per il quale si desidera spostare un'etichetta non è disponibile, verificare la regione.

    aws ssm describe-parameters

    Annotare il nome del parametro di cui si desidera visualizzare le etichette.

  2. Eseguire questo comando per visualizzare tutte le versioni del parametro.

    aws ssm get-parameter-history --name parameter-name --with-decryption

    Il sistema restituisce informazioni simili alle seguenti.

    {
    "Parameters": [
        {
            "Name": "/Config/endpoint", 
            "LastModifiedDate": 1528932105.382, 
            "Labels": [
                "Deprecated"
            ], 
            "Value": "MyTestService-June-Release.example.com", 
            "Version": 1, 
            "LastModifiedUser": "arn:aws:iam::123456789012:user/test", 
            "Type": "String"
        }, 
        {
            "Name": "/Config/endpoint", 
            "LastModifiedDate": 1528932111.222, 
            "Labels": [
                "Current"
            ], 
            "Value": "MyTestService-July-Release.example.com", 
            "Version": 2, 
            "LastModifiedUser": "arn:aws:iam::123456789012:user/test", 
            "Type": "String"
        }
    ]
}

Visualizzazione di un elenco di parametri a cui è assegnata un'etichetta (AWS CLI)

È possibile utilizzare l'operazione GetParametersByPathAPI per visualizzare un elenco di tutti i parametri in un percorso a cui è assegnata un'etichetta specifica.

Eseguire questo comando per visualizzare l'elenco dei parametri in un percorso a cui è assegnata un'etichetta specifica. Sostituisci ciascun segnaposto delle risorse di esempio con le tue informazioni.

aws ssm get-parameters-by-path \
    --path parameter-path \
    --parameter-filters Key=Label,Values=label-name,Option=Equals \
    --max-results a-number \
    --with-decryption --recursive

Il sistema restituisce informazioni simili alle seguenti. Per questo esempio, l'utente ha eseguito una ricerca nel percorso /Config.

{
    "Parameters": [
        {
            "Version": 3, 
            "Type": "SecureString", 
            "Name": "/Config/DBpwd", 
            "Value": "MyS@perGr&pass33"
        }, 
        {
            "Version": 2, 
            "Type": "String", 
            "Name": "/Config/DBusername", 
            "Value": "TestUserDB"
        }, 
        {
            "Version": 2, 
            "Type": "String", 
            "Name": "/Config/endpoint", 
            "Value": "MyTestService-July-Release.example.com"
        }
    ]
}

Spostamento di un'etichetta di parametro (AWS CLI)

La procedura riportata di seguito illustra come spostare un'etichetta di parametro in una versione diversa dello stesso parametro.

Per spostare un'etichetta di parametro

  1. Eseguire questo comando per visualizzare tutte le versioni del parametro. Sostituisci parameter name con le tue informazioni.

    aws ssm get-parameter-history \
    --name "parameter name"

    Prendi nota delle versioni dei parametri da e verso le quali desideri spostare l'etichetta.

  2. Eseguire questo comando per assegnare un'etichetta esistente a una versione diversa di un parametro. Sostituisci ciascun segnaposto delle risorse di esempio con le tue informazioni.

    aws ssm label-parameter-version \
    --name parameter name \
    --parameter-version version number \
    --labels name-of-existing-label
    Nota

    Se si desidera spostare un'etichetta esistente nella versione più recente di un parametro, rimuovere --parameter-version dal comando.

Eliminazione delle etichette di parametro (AWS CLI)

La procedura seguente descrive come eliminare le etichette di parametro tramite AWS CLI.

Eliminazione di un'etichetta di parametro

  1. Eseguire questo comando per visualizzare tutte le versioni del parametro. Sostituisci parameter name con le tue informazioni.

    aws ssm get-parameter-history \
    --name "parameter name"

    Il sistema restituisce informazioni simili alle seguenti.

    {
    "Parameters": [
        {
            "Name": "foo",
            "DataType": "text",
            "LastModifiedDate": 1607380761.11,
            "Labels": [
                "l3",
                "l2"
            ],
            "Value": "test",
            "Version": 1,
            "LastModifiedUser": "arn:aws:iam::123456789012:user/test",
            "Policies": [],
            "Tier": "Standard",
            "Type": "String"
        },
        {
            "Name": "foo",
            "DataType": "text",
            "LastModifiedDate": 1607380763.11,
            "Labels": [
                "l1"
            ],
            "Value": "test",
            "Version": 2,
            "LastModifiedUser": "arn:aws:iam::123456789012:user/test",
            "Policies": [],
            "Tier": "Standard",
            "Type": "String"
        }
    ]
}

    Annotare la versione di parametro della quale si desidera eliminare un'etichetta o delle etichette.

  2. Eseguire il comando seguente per eliminare le etichette selezionate da tale parametro. Sostituisci ciascun segnaposto delle risorse di esempio con le tue informazioni.

    aws ssm unlabel-parameter-version \
    --name parameter name \
    --parameter-version version \
    --labels label 1,label 2,label 3

    Il sistema restituisce informazioni simili alle seguenti.

    {
    "InvalidLabels": ["invalid"], 
    "DeletedLabels" : ["Prod"]
 }