Criar um parâmetro do Parameter Store usando as Ferramentas para Windows PowerShell - AWS Systems Manager
Criar um parâmetro string (Ferramentas para Windows PowerShell)Criar um parâmetro StringList (Ferramentas para Windows PowerShell)Criar um parâmetro SecureString (Ferramentas para Windows PowerShell)

Criar um parâmetro do Parameter Store usando as Ferramentas para Windows PowerShell

Você pode usar AWS Tools for Windows PowerShell para criar os tipos de parâmetro String, StringList e SecureString. Depois de excluir um parâmetro, aguarde pelo menos 30 segundos para criar um parâmetro com o mesmo nome.

Os parâmetros não podem ser referenciados ou aninhados nos valores de outros parâmetros. Não é possível incluir {{}} ou {{ssm:parameter-name}} em um valor de parâmetro.

nota

Parâmetros só estão disponíveis na região da Região da AWS em que foram criados.

Criar um parâmetro string (Ferramentas para Windows PowerShell)

  1. Instale e configure o AWS Tools for PowerShell (Ferramentas para Windows PowerShell), caso ainda não o tenha feito.

    Para obter informações, consulte Instalar o AWS Tools for PowerShell.

  2. Execute o seguinte comando para criar um parâmetro que contenha um valor de texto sem formatação. Substitua cada espaço reservado para recurso de exemplo por suas próprias informações.

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

    - ou -

    Execute o comando a seguir para criar um parâmetro que contenha um ID da Amazon Machine Image (AMI) como o valor do parâmetro.

    nota

    Para criar um parâmetro com uma tag, crie o service.model.tag antes da mão como uma variável. Aqui está um exemplo.

    $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

    A opção -DataType deverá ser especificada somente se você estiver criando um parâmetro que contenha um ID de AMI. Para todos os outros parâmetros, o tipo de dados padrão é text. Para ter mais informações, consulte Como usar o suporte a parâmetros nativos no Parameter Store para IDs de imagem de máquina da Amazon.

    Veja um de exemplo que usa uma hierarquia de parâmetros.

    Write-SSMParameter `
    -Name "/IAD/Web/SQL/IPaddress" `
    -Value "99.99.99.999" `
    -Type "String" `
    -Tags $tag

  3. Execute o seguinte comando para verificar os detalhes do parâmetro.

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

Criar um parâmetro StringList (Ferramentas para Windows PowerShell)

  1. Instale e configure o AWS Tools for PowerShell (Ferramentas para Windows PowerShell), caso ainda não o tenha feito.

    Para obter informações, consulte Instalar o AWS Tools for PowerShell.

  2. Execute o seguinte comando para criar um parâmetro StringList. Substitua cada espaço reservado para recurso de exemplo por suas próprias informações.

    nota

    Para criar um parâmetro com uma tag, crie o service.model.tag antes da mão como uma variável. Aqui está um exemplo. 

    $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

    Se for bem-sucedido, o comando retornará o número da versão do parâmetro.

    Aqui está um exemplo.

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

    Os itens em uma StringList devem ser separados por uma vírgula (,). Não é possível usar outros sinais de pontuação ou caracteres especiais para inserir um caractere de escape para os itens da lista. Se você tiver um valor de parâmetro que requer uma vírgula, use o tipo String.

  3. Execute o seguinte comando para verificar os detalhes do parâmetro.

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

Criar um parâmetro SecureString (Ferramentas para Windows PowerShell)

Para criar um parâmetro SecureString, primeiro leia a respeito dos requisitos para esse tipo de parâmetro. Para ter mais informações, consulte Criar um parâmetro SecureString usando a AWS CLI.

Importante

Somente o valor de um parâmetro SecureString é criptografado. O nome do parâmetro, a descrição e outras propriedades não são criptografados.

Importante

O Parameter Store só oferece suporte a chaves de criptografia simétricas KMS. Não é possível usar uma chave de criptografia KMS assimétrica para criptografar os parâmetros. Para obter ajuda para determinar se uma KMS é simétrica ou assimétrica, consulte Identificar KMSs simétricas e assimétricas no Manual do desenvolvedor do AWS Key Management Service.

  1. Instale e configure o AWS Tools for PowerShell (Ferramentas para Windows PowerShell), caso ainda não o tenha feito.

    Para obter informações, consulte Instalar o AWS Tools for PowerShell.

  2. Execute o seguinte comando para criar um parâmetro. Substitua cada espaço reservado para recurso de exemplo por suas próprias informações.

    nota

    Para criar um parâmetro com uma tag, primeiro crie o service.model.tag como uma variável. Aqui está um exemplo. 

    $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

    Se for bem-sucedido, o comando retornará o número da versão do parâmetro.

    nota

    Para usar a Chave gerenciada pela AWS atribuída à sua conta, remova o parâmetro -KeyId do comando.

    Veja a seguir um exemplo que usa um nome ofuscado (3l3vat3131) para um parâmetro de senha e uma Chave gerenciada pela AWS.

    Write-SSMParameter `
    -Name "/Finance/Payroll/3l3vat3131" `
    -Value "P@sSwW)rd" `
    -Type "SecureString"`
    -Tags $tag

  3. Execute o seguinte comando para verificar os detalhes do parâmetro.

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

Por padrão, todos os valores de SecureString são exibidos como texto cifrado. Para descriptografar um valor de SecureString, um usuário deve ter permissão para chamar a operação da API Decrypt do AWS KMS. Para obter informações sobre como configurar o controle de acesso do AWS KMS, consulte Autenticação e controle de acesso para o AWS KMS no Manual de desenvolvedor do AWS Key Management Service.

Importante

Se você alterar o alias da chave KMS para a chave KMS usada para criptografar um parâmetro, também será necessário atualizar o alias de chave que o parâmetro usa para referenciar a AWS KMS. Isso se aplica somente ao alias da chave KMS; o ID da chave que um alias anexa permanece o mesmo, a menos que você exclua a chave inteira.