Trabalhar com rótulos de parâmetros () - AWS Systems Manager
Trabalhar com rótulos de parâmetros (console)Trabalhar com rótulos de parâmetros (AWS CLI)

Trabalhar com rótulos de parâmetros ()

Um rótulo de parâmetro é um alias definido pelo usuário para ajudar você a gerenciar diferentes versões de um parâmetro. Quando você modifica um parâmetro, o AWS Systems Manager salva automaticamente uma nova versão e incrementa o número da versão em um. Um rótulo pode ajudar você a lembrar-se do objetivo de uma versão de parâmetro quando houver várias versões.

Por exemplo, digamos que você tenha um parâmetro chamado /MyApp/DB/ConnectionString. O valor do parâmetro é uma string de conexão a um servidor MySQL em um banco de dados local em um ambiente de teste. Depois de concluir a atualização do aplicativo, você deseja que o parâmetro use uma string de conexão para um banco de dados de produção. Você altera o valor de /MyApp/DB/ConnectionString. O Systems Manager cria automaticamente a versão dois com a nova string de conexão. Para ajudar você a lembrar-se do objetivo de cada versão, anexe um rótulo a cada parâmetro. Para a versão um, você anexa o rótulo Test e para a versão dois você anexa o rótulo Production.

Você pode mover rótulos de uma versão de um parâmetro para outra versão. Por exemplo, se você criar a versão 3 do parâmetro /MyApp/DB/ConnectionString com uma string de conexão para um novo banco de dados de produção, poderá mover o rótulo Production da versão 2 para a versão 3 do parâmetro.

Os rótulos de parâmetros são uma alternativa leve para tags de parâmetros. Sua organização pode ter diretrizes estritas para tags que devem ser aplicadas a diferentes recursos da AWS. Por outro lado, um rótulo é simplesmente uma associação de texto para uma versão de um parâmetro.

De forma semelhante a tags, você pode consultar parâmetros usando rótulos. Você pode visualizar uma lista de todas as versões de parâmetros específicos que usam o mesmo rótulo, se consultar o conjunto de parâmetros usando a ação da API GetParametersByPath, conforme descrito mais adiante nesta seção.

nota

Se você executar um comando que especifica uma versão de um parâmetro que não existe, o comando falhará. Ele não retornará ao valor mais recente ou padrão do parâmetro.

Requisitos e restrições de rótulos

Os rótulos de parâmetros têm os seguintes requisitos e restrições:

  • Uma versão de um parâmetro pode ter no máximo 10 rótulos.

  • Você não pode anexar o mesmo rótulo a diferentes versões do mesmo parâmetro. Por exemplo, se a versão 1 do parâmetro tiver o rótulo Production (Produção), você não poderá anexar Production à versão 2.

  • Você pode mover um rótulo de uma versão de um parâmetro para outra.

  • Você não pode criar um rótulo ao criar um parâmetro. Você deve anexar um rótulo a uma versão específica de um parâmetro.

  • Se você não quiser mais usar um rótulo de parâmetro, deverá movê-lo para uma versão diferente de um parâmetro.

  • Um rótulo pode ter no máximo 100 caracteres.

  • Os rótulos podem conter letras (diferenciando maiúsculas de minúsculas), números, pontos (.), hifens (-) ou sublinhados (_).

  • Os rótulos não podem começar com um número, "aws", ou "ssm" (sem diferenciação de maiúsculas de minúsculas). Se um rótulo não atender a esses requisitos, ele não será anexado à versão do parâmetro, e o sistema o exibirá na lista de InvalidLabels.

Trabalhar com rótulos de parâmetros (console)

Esta seção descreve como executar as seguintes tarefas usando o console do Systems Manager.

Crie um rótulo do parâmetro (console)

O procedimento a seguir descreve como anexar um rótulo a uma versão específica de um parâmetro existente usando o console do Systems Manager. Você não pode anexar um rótulo ao criar um parâmetro.

Anexar um rótulo à versão mais recente de um parâmetro

  1. Abra o console AWS Systems Manager em https://console.aws.amazon.com/systems-manager/.

  2. No painel de navegação, escolha Parameter Store.

  3. Escolha o nome de um parâmetro para abrir a página de detalhes desse parâmetro.

  4. Escolha a guia History (Histórico).

  5. Escolha a versão do parâmetro à qual você deseja anexar um rótulo.

  6. Selecione Manage labels (Gerenciar rótulos).

  7. Selecione Add new label (Adicionar novo rótulo).

  8. Na caixa de texto, insira o nome do rótulo. Para adicionar mais rótulos, escolha Add another label (Adicionar outro rótulo). Você pode anexar um máximo de dez rótulos.

  9. Ao concluir, escolha Salvar alterações.

Visualizar rótulos anexados a um parâmetro (console)

Uma versão de um parâmetro pode ter um máximo de 10 rótulos. O procedimento a seguir descreve como visualizar todos os rótulos anexados a uma versão de um parâmetro usando o console do Systems Manager.

Para visualizar rótulos anexados a uma versão do parâmetro

  1. Abra o console AWS Systems Manager em https://console.aws.amazon.com/systems-manager/.

  2. No painel de navegação, escolha Parameter Store.

  3. Escolha o nome de um parâmetro para abrir a página de detalhes desse parâmetro.

  4. Escolha a guia History (Histórico).

  5. Localize a versão ao parâmetro do qual você deseja visualizar todos os rótulos anexados. A coluna Labels (Rótulos) mostra todos os rótulos anexados à versão do parâmetro.

Mover o rótulo de um parâmetro (console)

O procedimento a seguir descreve como mover um rótulo de um parâmetro para outra versão do mesmo parâmetro usando o console do Systems Manager.

Para mover um rótulo para outra versão de um parâmetro usando o console

  1. Abra o console AWS Systems Manager em https://console.aws.amazon.com/systems-manager/.

  2. No painel de navegação, escolha Parameter Store.

  3. Escolha o nome de um parâmetro para abrir a página de detalhes desse parâmetro.

  4. Escolha a guia History (Histórico).

  5. Escolha a versão do parâmetro para o qual você deseja mover o rótulo.

  6. Selecione Manage labels (Gerenciar rótulos).

  7. Selecione Add new label (Adicionar novo rótulo).

  8. Na caixa de texto, insira o nome do rótulo.

  9. Ao concluir, escolha Salvar alterações.

Exclua os rótulos do parâmetros (console)

O procedimento a seguir descreve como excluir um ou vários rótulos de parâmetros usando o console do Systems Manager.

Para excluir rótulos de um parâmetro

  1. Abra o console AWS Systems Manager em https://console.aws.amazon.com/systems-manager/.

  2. No painel de navegação, escolha Parameter Store.

  3. Escolha o nome de um parâmetro para abrir a página de detalhes desse parâmetro.

  4. Escolha a guia History (Histórico).

  5. Escolha a versão do parâmetro para o qual você deseja excluir os rótulos.

  6. Selecione Manage labels (Gerenciar rótulos).

  7. Selecione Remove (Remover) ao lado de cada rótulo que você quiser excluir.

  8. Ao concluir, escolha Salvar alterações.

  9. Confirme se as alterações estão corretas, digite Confirm na caixa de texto e escolha Confirm (Confirmar).

Trabalhar com rótulos de parâmetros (AWS CLI)

Esta seção descreve como executar as seguintes tarefas usando a AWS Command Line Interface (AWS CLI).

Crie um rótulo de parâmetro (AWS CLI)

O procedimento a seguir descreve como anexar um rótulo a uma versão específica de um parâmetro existente usando a AWS CLI. Você não pode anexar um rótulo ao criar um parâmetro.

Para criar um novo rótulo de parâmetro

  1. Instale e configure a AWS Command Line Interface (AWS CLI), caso ainda não o tenha feito.

    Para obter informações, consulte Instalar ou atualizar a versão mais recente da AWS CLI.

  2. Execute o seguinte comando para visualizar uma lista de parâmetros para os quais você tem permissão para anexar um rótulo.

    nota

    Parâmetros só estão disponíveis na região da Região da AWS em que foram criados. Se não vir um parâmetro ao qual você deseja anexar um rótulo, verifique sua região.

    aws ssm describe-parameters

    Anote o nome de um parâmetro ao qual você quer anexar um rótulo.

  3. Execute o comando a seguir para visualizar todas as versões do parâmetro.

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

    Anote a versão do parâmetro à qual você deseja anexar um rótulo.

  4. Execute o comando a seguir para recuperar informações sobre um parâmetro pelo número da versão.

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

    Aqui está um exemplo.

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

  5. Execute um dos seguintes comandos para anexar um rótulo a uma versão de um parâmetro. Se você anexar vários rótulos, deverá separar os nomes dos rótulos com um espaço.

    Anexar um rótulo à versão mais recente de um parâmetro

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

    Anexar um rótulo a uma versão específica de um parâmetro

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

    Aqui estão alguns exemplos.

    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 a saída mostrar o rótulo que você criou na lista InvalidLabels, o rótulo não atenderá aos requisitos descritos anteriormente neste tópico. Verifique os requisitos e tente novamente. Se a lista InvalidLabels estiver vazia, seu rótulo terá sido aplicado com êxito para a versão do parâmetro.

  6. Você pode visualizar os detalhes do parâmetro usando um número de versão ou um nome de rótulo. Execute o seguinte comando e especifique o rótulo que você criou na etapa anterior.

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

    O comando retorna informações como as seguintes.

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

    O seletor na saída é o número da versão ou o rótulo que você especificou no campo de entrada Name.

Visualizar os rótulos para um parâmetro (AWS CLI)

Você pode usar a operação da API GetParameterHistory para visualizar todo o histórico e todos os rótulos anexados a um parâmetro específico. Ou, você pode usar a ação da API GetParametersByPath para visualizar uma lista de todos os parâmetros atribuídos a um rótulo específico.

Para visualizar os rótulos de um parâmetro usando a operação da API GetParameterHistory

  1. Execute o seguinte comando para visualizar uma lista dos parâmetros dos quais você pode visualizar rótulos.

    nota

    Parâmetros só estão disponíveis na região em que foram criados. Se não vir um parâmetro para o qual você deseja mover um rótulo, verifique sua região.

    aws ssm describe-parameters

    Anote o nome do parâmetro que contém os rótulos que você deseja exibir.

  2. Execute o comando a seguir para visualizar todas as versões do parâmetro.

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

    O sistema retorna informações como estas.

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

Visualizar uma lista de parâmetros atribuídos a um rótulo (AWS CLI)

Você pode usar a operação da API GetParametersByPath para visualizar uma lista de todos os parâmetros em um caminho, que estiverem atribuídos a um rótulo específico.

Execute o seguinte comando para visualizar uma lista de parâmetros em um caminho atribuídos a um rótulo específico. Substitua cada espaço reservado para recurso de exemplo por suas próprias informações.

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

O sistema retorna informações como estas. Para este exemplo, o usuário pesquisou no caminho /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"
        }
    ]
}

Mover o rótulo de um parâmetroAWS CLI

O procedimento a seguir descreve como mover um rótulo de um parâmetro para outra versão do mesmo parâmetro.

Para mover um rótulo de um parâmetro

  1. Execute o comando a seguir para visualizar todas as versões do parâmetro. Substitua nome do parâmetro pelas suas próprias informações.

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

    Observe as versões do parâmetro para o qual você deseja mover o rótulo do e do.

  2. Execute o seguinte comando para atribuir um rótulo existente para uma versão diferente de um parâmetro. Substitua cada espaço reservado para recurso de exemplo por suas próprias informações.

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

    Se você desejar mover um rótulo existente para a versão mais recente de um parâmetro, remova --parameter-version do comando.

Exclua os rótulos do parâmetro (AWS CLI)

O procedimento a seguir descreve como excluir rótulos de parâmetros usando aAWS CLI.

Para excluir um parameter group

  1. Execute o comando a seguir para visualizar todas as versões do parâmetro. Substitua nome do parâmetro pelas suas próprias informações.

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

    O sistema retorna informações como estas.

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

    Anote a versão do parâmetro à qual você deseja anexar um rótulo.

  2. Execute o comando a seguir para excluir os rótulos escolhidos desse parâmetro. Substitua cada espaço reservado para recurso de exemplo por suas próprias informações.

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

    O sistema retorna informações como estas.

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