Create a String parameter (Tools for Windows PowerShell)Create a StringList parameter (Tools for Windows PowerShell)Create a SecureString parameter (Tools for Windows PowerShell)

Create a Systems Manager parameter (Tools for Windows PowerShell)

You can use Amazon Tools for Windows PowerShell to create String, StringList, and SecureString parameter types. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.

Parameters can't be referenced or nested in the values of other parameters. You can't include {{}} or {{ssm:parameter-name}} in a parameter value.

Note

Parameters are only available in the Amazon Web Services Region where they were created.

Topics

Create a String parameter (Tools for Windows PowerShell)
Create a StringList parameter (Tools for Windows PowerShell)
Create a SecureString parameter (Tools for Windows PowerShell)

Create a `String` parameter (Tools for Windows PowerShell)

Install and configure the Amazon Tools for PowerShell (Tools for Windows PowerShell), if you haven't already.

For information, see Installing the Amazon Tools for PowerShell.
Run the following command to create a parameter that contains a plain text value. Replace each example resource placeholder with your own information.
```
Write-SSMParameter `
    -Name "parameter-name" `
    -Value "parameter-value" `
    -Type "String"
```
-or-

Run the following command to create a parameter that contains an Amazon Machine Image (AMI) ID as the parameter value.
Note
To create a parameter with a tag, create the service.model.tag before hand as a variable. Here is an example.
```
$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
```
The -DataType option must be specified only if you are creating a parameter that contains an AMI ID. For all other parameters, the default data type is text. For more information, see Native parameter support for Amazon Machine Image IDs.

Here is an example that uses a parameter hierarchy.
```
Write-SSMParameter `
    -Name "/IAD/Web/SQL/IPaddress" `
    -Value "99.99.99.999" `
    -Type "String" `
    -Tags $tag
```
Run the following command to verify the details of the parameter.
```
(Get-SSMParameterValue -Name "the-parameter-name-you-specified").Parameters
```

Create a `StringList` parameter (Tools for Windows PowerShell)

Install and configure the Amazon Tools for PowerShell (Tools for Windows PowerShell), if you haven't already.

For information, see Installing the Amazon Tools for PowerShell.
Run the following command to create a StringList parameter. Replace each example resource placeholder with your own information.
Note
To create a parameter with a tag, create the service.model.tag before hand as a variable. Here is an example.
```
$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
```
If successful, the command returns the version number of the parameter.

Here is an example.
```
Write-SSMParameter `
    -Name "stringlist-parameter" `
    -Value "Milana,Mariana,Mark,Miguel" `
    -Type "StringList" `
    -Tags $tag
```
Note
Items in a StringList must be separated by a comma (,). You can't use other punctuation or special characters to escape items in the list. If you have a parameter value that requires a comma, then use the String type.
Run the following command to verify the details of the parameter.
```
(Get-SSMParameterValue -Name "the-parameter-name-you-specified").Parameters
```

Create a SecureString parameter (Tools for Windows PowerShell)

Before you create a SecureString parameter, read about the requirements for this type of parameter. For more information, see Create a SecureString parameter (Amazon CLI).

Important

Only the value of a SecureString parameter is encrypted. Parameter names, descriptions, and other properties aren't encrypted.

Important

Parameter Store only supports symmetric encryption KMS keys. You can't use an asymmetric encryption KMS key to encrypt your parameters. For help determining whether a KMS key is symmetric or asymmetric, see Identifying symmetric and asymmetric KMS keys in the Amazon Key Management Service Developer Guide

Install and configure the Amazon Tools for PowerShell (Tools for Windows PowerShell), if you haven't already.

For information, see Installing the Amazon Tools for PowerShell.
Run the following command to create a parameter. Replace each example resource placeholder with your own information.
Note
To create a parameter with a tag, first create the service.model.tag as a variable. Here is an example.
```
$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 Amazon KMS key ID, an Amazon KMS key ARN, an alias name, or an alias ARN" `
    -Tags $tag
```
If successful, the command returns the version number of the parameter.

Note
To use the Amazon managed key assigned to your account, remove the -KeyId parameter from the command.

Here is an example that uses an obfuscated name (3l3vat3131) for a password parameter and an Amazon managed key.
```
Write-SSMParameter `
    -Name "/Finance/Payroll/3l3vat3131" `
    -Value "P@sSwW)rd" `
    -Type "SecureString"`
    -Tags $tag
```

Run the following command to verify the details of the parameter.


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

By default, all SecureString values are displayed as cipher-text. To decrypt a SecureString value, a user must have permission to call the Amazon KMS Decrypt API operation. For information about configuring Amazon KMS access control, see Authentication and Access Control for Amazon KMS in the Amazon Key Management Service Developer Guide.

Important

If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference Amazon KMS. This only applies to the KMS key alias; the key ID that an alias attaches to stays the same unless you delete the whole key.

Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Create a Systems Manager parameter (Amazon CLI)

Searching for parameters