Systems Manager での Parameter Store パラメータの検索

アカウントに多数のパラメータがある場合、一度に1つまたは複数のパラメータに関する情報を見つけるのが難しい場合があります。このような場合は、フィルタツールを使用して検索条件を指定することで、必要な情報を検索できます。AWS Systems Manager コンソール、AWS Command Line Interface (AWS CLI)、AWS Tools for PowerShell、または DescribeParameters API を使用してパラメータを検索できます。

コンソールを使用してパラメータを検索する

1. AWS Systems Manager コンソール (https://console.aws.amazon.com/systems-manager/) を開きます。

2. ナビゲーションペインで、[Parameter Store] を選択します。

3. 検索ボックスを選択し、検索方法を選択します。例えば、Type、Name などです。

4. 選択した検索タイプの情報を入力します。以下に例を示します。

   • Type で検索する場合は、String、StringList、SecureString から選択します。

   • Name で検索する場合は、contains、equals、または begins-with を選択し、パラメータ名のすべてまたは一部を入力します。

     注記

     コンソールでは、Name のデフォルトの検索タイプは contains です。

5. [Enter] キーを押します。

パラメータのリストが検索結果で更新されます。

AWS CLI を使用してパラメータを検索する

describe-parameters の 1 つ以上のパラメータに関する情報を表示するには、AWS CLI コマンドを使用します。

以下の例は、 のパラメータに関する情報を表示するために使用できるさまざまなオプションを示していますAWS アカウント これらのオプションの詳細については、「AWS Command Line Interface ユーザーガイド」の「describe-parameters」を参照してください。

1. まだ AWS Command Line Interface (AWS CLI) をインストールして設定していない場合は、インストールして設定します。

   詳細については、「AWS CLI の最新バージョンをインストールまたは更新します。」を参照してください。

2. 以下のコマンドのサンプル値を、アカウントで作成されたパラメータを反映した値に置き換えます。

   Linux & macOS

   aws ssm describe-parameters \
       --parameter-filters "Key=Name,Values=MyParameterName"

   Windows

   aws ssm describe-parameters ^
       --parameter-filters "Key=Name,Values=MyParameterName"

   注記

   describe-parameters の場合、Name のデフォルトの検索タイプは Equals です。パラメータフィルタで、"Key=Name,Values=MyParameterName" を指定することは、"Key=Name,Option=Equals,Values=MyParameterName" を指定することと同じです。

   aws ssm describe-parameters \
       --parameter-filters "Key=Name,Option=Contains,Values=Product"

   aws ssm describe-parameters \
       --parameter-filters "Key=Type,Values=String"

   aws ssm describe-parameters \
       --parameter-filters "Key=Path,Values=/Production/West"

   aws ssm describe-parameters \
       --parameter-filters "Key=Tier,Values=Standard"

   aws ssm describe-parameters \
       --parameter-filters "Key=tag:tag-key,Values=tag-value"

   aws ssm describe-parameters \
       --parameter-filters "Key=KeyId,Values=key-id"

   注記

   最後の例の key-id は、アカウントで作成された AWS Key Management Service パラメータの暗号化に使用される AWS KMS (SecureString) キーの ID を表します。また、alias/aws/ssm を入力して、アカウントのデフォルトの AWS KMS キーを使用することもできます。詳細については、「」を参照してくださいAWS CLI を使用して SecureString パラメータを作成するには

   成功すると、コマンドは以下のような出力を返します。

   {
       "Parameters": [
           {
               "Name": "/Production/West/Manager",
               "Type": "String",
               "LastModifiedDate": 1573438580.703,
               "LastModifiedUser": "arn:aws:iam::111122223333:user/Mateo.Jackson",
               "Version": 1,
               "Tier": "Standard",
               "Policies": []
           },
           {
               "Name": "/Production/West/TeamLead",
               "Type": "String",
               "LastModifiedDate": 1572363610.175,
               "LastModifiedUser": "arn:aws:iam::111122223333:user/Mateo.Jackson",
               "Version": 1,
               "Tier": "Standard",
               "Policies": []
           },
           {
               "Name": "/Production/West/HR",
               "Type": "String",
               "LastModifiedDate": 1572363680.503,
               "LastModifiedUser": "arn:aws:iam::111122223333:user/Mateo.Jackson",
               "Version": 1,
               "Tier": "Standard",
               "Policies": []
           }
       ]
   }