AWS Tools for Windows PowerShell を使用して、String
、StringList
、SecureString
パラメータタイプを作成できます。パラメータを削除したら、30 秒以上待ってから同じ名前のパラメータを作成します。
パラメータは、他のパラメータの値で参照またはネストすることはできません。パラメータ値に {{}}
または {{ssm:
を含めることはできません。parameter-name
}}
注記
パラメータは、パラメータを作成した AWS リージョン でのみ使用できます。
トピック
String パラメータを作成する (Tools for Windows PowerShell)
AWS Tools for PowerShell (Tools for Windows PowerShell) をインストールして設定します (まだインストールしていない場合)。
詳細については、「AWS Tools for PowerShell のインストール」を参照してください。
-
以下のコマンドを実行して、プレーンテキスト値を含むパラメータを作成します。各
リソースプレースホルダーの例
をユーザー自身の情報に置き換えます。Write-SSMParameter ` -Name "
parameter-name
" ` -Value "parameter-value
" ` -Type "String"-または-
次のコマンドを実行して、パラメータ値として Amazon Machine Image (AMI) ID を含むパラメータを作成します。
注記
タグ付きのパラメータを作成するには、変数として手前で service.model.tag を作成します。以下はその例です。
$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-DataType
オプションは、AMI ID を含むパラメータを作成する場合にのみ指定する必要があります。他のすべてのパラメータでは、デフォルトのデータ型はtext
です。詳細については、「」を参照してくださいAmazon マシンイメージ ID の Parameter Store でのパラメータのネイティブサポートの利用以下に示しているのは、パラメータ階層の使用例です。
Write-SSMParameter ` -Name "/IAD/Web/SQL/IPaddress" ` -Value "99.99.99.999" ` -Type "String" ` -Tags $tag
-
パラメータの詳細を確認するには、以下のコマンドを実行します。
(Get-SSMParameterValue -Name "
the-parameter-name-you-specified
").Parameters
StringList パラメータを作成する (Tools for Windows PowerShell )
AWS Tools for PowerShell (Tools for Windows PowerShell) をインストールして設定します (まだインストールしていない場合)。
詳細については、「AWS Tools for PowerShell のインストール」を参照してください。
-
以下のコマンドを実行して、StringList パラメータを作成します。各
リソースプレースホルダーの例
をユーザー自身の情報に置き換えます。注記
タグ付きのパラメータを作成するには、変数として手前で service.model.tag を作成します。以下はその例です。
$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成功すると、コマンドはパラメータのバージョン番号を返します。
以下はその例です。
Write-SSMParameter ` -Name "stringlist-parameter" ` -Value "Milana,Mariana,Mark,Miguel" ` -Type "StringList" ` -Tags $tag
注記
StringList
の項目はカンマ (,) で区切る必要があります。他の句読点または特殊文字を使用してリスト内の項目をエスケープすることはできません。カンマを必要とするパラメータ値がある場合は、String
型を使用してください。 -
パラメータの詳細を確認するには、以下のコマンドを実行します。
(Get-SSMParameterValue -Name "
the-parameter-name-you-specified
").Parameters
SecureString パラメータを作成する (Tools for Windows PowerShell)
SecureString
パラメータを作成する前に、このタイプのパラメータに関する前提要件を確認してください。詳細については、「AWS CLI を使用して SecureString パラメータを作成するには」を参照してください。
重要
SecureString
パラメータの値のみが暗号化されます。パラメータ名、説明などのプロパティは暗号化されません。
重要
Parameter Store では、対称暗号化 KMS キーのみをサポートしています。非対称暗号化 KMS キーを使用してパラメータを暗号化することはできません。KMS キーが対称か非対称かを判断する方法については、「AWS Key Management Service デベロッパーガイド」の「対称キーと非対称 KMS キーの識別」を参照してください。
AWS Tools for PowerShell (Tools for Windows PowerShell) をインストールして設定します (まだインストールしていない場合)。
詳細については、「AWS Tools for PowerShell のインストール」を参照してください。
-
以下のコマンドを実行してパラメータを作成します。各
リソースプレースホルダーの例
をユーザー自身の情報に置き換えます。注記
タグ付きのパラメータを作成するには、まず service.model.tag を変数として作成します。以下はその例です。
$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成功すると、コマンドはパラメータのバージョン番号を返します。
注記
アカウントに割り当てられた AWS マネージドキーを使用するには、コマンドから
-KeyId
パラメータを削除します。難読化された名前 (3l3vat3131) をパスワードパラメータとして使用し、AWS マネージドキーを使用する例を次に示します。
Write-SSMParameter ` -Name "/Finance/Payroll/3l3vat3131" ` -Value "P@sSwW)rd" ` -Type "SecureString"` -Tags $tag
-
パラメータの詳細を確認するには、以下のコマンドを実行します。
(Get-SSMParameterValue -Name "
the-parameter-name-you-specified
" –WithDecryption $true).Parameters
デフォルトでは、すべての SecureString
値が暗号化テキストとして表示されます。SecureString
値を復号するには、AWS KMS の Decrypt API オペレーションを呼び出すためのアクセス権限が必要です。AWS KMS アクセスコントロールの設定方法については、「AWS Key Management Service デベロッパーガイド」の「AWS KMS に対する認証とアクセスコントロール」を参照してください。
重要
パラメータの暗号化に使用される KMS キーの KMS キーエイリアスを変更する場合は、パラメータが AWS KMS の参照で使用するキーエイリアスも更新する必要があります。これは KMS キーエイリアスにのみ適用されます。エイリアスがアタッチするキー ID は、キー全体を削除しない限り、同じままになります。