Usar GetParameters com uma CLI - Exemplos de código do AWS SDK

Há mais exemplos do AWS SDK disponíveis no repositório do GitHub Documento de Exemplos do AWS SDK.

Usar GetParameters com uma CLI

Os exemplos de código a seguir mostram como usar o GetParameters.

CLI
AWS CLI

Exemplo 1: listar os valores de um parâmetro

O exemplo de get-parameters a seguir lista os valores dos três parâmetros especificados.

aws ssm get-parameters \
    --names "MyStringParameter" "MyStringListParameter" "MyInvalidParameterName"

Saída:

{
    "Parameters": [
        {
            "Name": "MyStringListParameter",
            "Type": "StringList",
            "Value": "alpha,beta,gamma",
            "Version": 1,
            "LastModifiedDate": 1582154764.222,
            "ARN": "arn:aws:ssm:us-east-2:111222333444:parameter/MyStringListParameter"
            "DataType": "text"
        },
        {
            "Name": "MyStringParameter",
            "Type": "String",
            "Value": "Vici",
            "Version": 3,
            "LastModifiedDate": 1582156117.545,
            "ARN": "arn:aws:ssm:us-east-2:111222333444:parameter/MyStringParameter"
            "DataType": "text"
        }
    ],
    "InvalidParameters": [
        "MyInvalidParameterName"
    ]
}

Para obter mais informações, consulte Trabalhar com o Parameter Store no Guia do usuário do AWS Systems Manager.

Exemplo 2: listar nomes e valores de vários parâmetros usando a opção "--query"

O exemplo de get-parameters a seguir lista os nomes e valores dos parâmetros especificados.

aws ssm get-parameters \
    --names MyStringParameter MyStringListParameter \
    --query "Parameters[*].{Name:Name,Value:Value}"

Saída:

[
    {
        "Name": "MyStringListParameter",
        "Value": "alpha,beta,gamma"
    },
    {
        "Name": "MyStringParameter",
        "Value": "Vidi"
    }
]

Para obter mais informações, consulte Trabalhar com o Parameter Store no Guia do usuário do AWS Systems Manager.

Exemplo 3: exibir o valor de um parâmetro usando rótulos

O exemplo de get-parameter a seguir lista o valores do parâmetros especificado com um rótulo especificado.

aws ssm get-parameter \
    --name "MyParameter:label"

Saída:

{
    "Parameters": [
        {
            "Name": "MyLabelParameter",
            "Type": "String",
            "Value": "parameter by label",
            "Version": 1,
            "Selector": ":label",
            "LastModifiedDate": "2021-07-12T09:49:15.865000-07:00",
            "ARN": "arn:aws:ssm:us-west-2:786973925828:parameter/MyParameter",
            "DataType": "text"
        },
        {
            "Name": "MyVersionParameter",
            "Type": "String",
            "Value": "parameter by version",
            "Version": 2,
            "Selector": ":2",
            "LastModifiedDate": "2021-03-24T16:20:28.236000-07:00",
            "ARN": "arn:aws:ssm:us-west-2:786973925828:parameter/unlabel-param",
            "DataType": "text"
        }
    ],
    "InvalidParameters": []
}

Para obter mais informações, consulte Trabalhar com rótulos de parâmetros no Guia do usuário do AWS Systems Manager.

  • Consulte detalhes da API em GetParameters na Referência de comandos da AWS CLI.

PowerShell
Ferramentas para PowerShell V4

Exemplo 1: esse exemplo lista os valores de um parâmetro.

Get-SSMParameterValue -Name "Welcome"

Saída:

InvalidParameters Parameters
----------------- ----------
{}                {Welcome}

Exemplo 2: esse exemplo retorna os detalhes do valor.

(Get-SSMParameterValue -Name "Welcome").Parameters

Saída:

Name    Type   Value
----    ----   -----
Welcome String Good day, Sunshine!

  • Consulte detalhes da API em GetParameters na Referência de cmdlets do Ferramentas da AWS para PowerShell (V4).

Ferramentas para PowerShell V5

Exemplo 1: esse exemplo lista os valores de um parâmetro.

Get-SSMParameterValue -Name "Welcome"

Saída:

InvalidParameters Parameters
----------------- ----------
{}                {Welcome}

Exemplo 2: esse exemplo retorna os detalhes do valor.

(Get-SSMParameterValue -Name "Welcome").Parameters

Saída:

Name    Type   Value
----    ----   -----
Welcome String Good day, Sunshine!

  • Consulte detalhes da API em GetParameters na Referência de cmdlets do Ferramentas da AWS para PowerShell (V5).