Amazon ECS に最適化された Windows AMI メタデータを取得する - Amazon Elastic Container Service
Systems Manager パラメータストアのパラメータフォーマット例

Amazon ECS に最適化された Windows AMI メタデータを取得する

Amazon ECS に最適化された AMI の各バリアントの AMI ID、イメージ名、オペレーティングシステム、コンテナエージェントバージョン、ランタイムバージョンは、Systems Manager パラメータストア API のクエリを実行してプログラムで取得できます。Systems Manager パラメータストア API の詳細については、「GetParameters」および「GetParametersByPath」を参照してください。

注記

Amazon ECS に最適化された AMI メタデータを取得するには、管理ユーザーに次の IAM アクセス権限が必要です。AmazonECS_FullAccess IAM ポリシーには、次の許可が追加されています。

  • ssm:GetParameters

  • ssm:GetParameter

  • ssm:GetParametersByPath

Systems Manager パラメータストアのパラメータフォーマット

注記

以下の Systems Manager Parameter Store API パラメータは廃止されているため、最新の Windows AMI の取得には使用しないでください。

  • /aws/service/ecs/optimized-ami/windows_server/2016/english/full/recommended/image_id

  • /aws/service/ecs/optimized-ami/windows_server/2019/english/full/recommended/image_id

以下は、各 Amazon ECS に最適化された AMI バリアントのパラメータ名のフォーマットです。

  • Windows Server 2022 Full AMI メタデータ:

    /aws/service/ami-windows-latest/Windows_Server-2022-English-Full-ECS_Optimized

  • Windows Server 2022 Core AMI メタデータ:

    /aws/service/ami-windows-latest/Windows_Server-2022-English-Core-ECS_Optimized

  • Windows Server 2019 フル AMI メタデータ:

    /aws/service/ami-windows-latest/Windows_Server-2019-English-Full-ECS_Optimized

  • Windows Server 2019 コア AMI メタデータ:

    /aws/service/ami-windows-latest/Windows_Server-2019-English-Core-ECS_Optimized

  • Windows Server 2016 フル AMI メタデータ:

    /aws/service/ami-windows-latest/Windows_Server-2016-English-Full-ECS_Optimized

次のパラメーター名の形式は、最新の安定した Windows Server 2019 Full AMI のメタデータを取得します

aws ssm get-parameters --names /aws/service/ami-windows-latest/Windows_Server-2019-English-Full-ECS_Optimized

以下は、パラメータ値で返る JSON オブジェクトの例です。

{
    "Parameters": [
        {
            "Name": "/aws/service/ami-windows-latest/Windows_Server-2019-English-Full-ECS_Optimized",
            "Type": "String",
            "Value": "{\"image_name\":\"Windows_Server-2019-English-Full-ECS_Optimized-2023.06.13\",\"image_id\":\"ami-0debc1fb48e4aee16\",\"ecs_runtime_version\":\"Docker (CE) version 20.10.21\",\"ecs_agent_version\":\"1.72.0\"}",
            "Version": 58,
            "LastModifiedDate": "2023-06-22T19:37:37.841000-04:00",
            "ARN": "arn:aws:ssm:us-east-1::parameter/aws/service/ami-windows-latest/Windows_Server-2019-English-Full-ECS_Optimized",
            "DataType": "text"
        }
    ],
    "InvalidParameters": []
}

上記の出力の各フィールドは、サブパラメータとしてクエリに利用できます。サブパラメータのパラメータパスを構築するには、選択した AMI のパスにサブパラメータ名を追加します。以下のサブパラメータが利用可能です。

  • schema_version

  • image_id

  • image_name

  • os

  • ecs_agent_version

  • ecs_runtime_version

例

以下の例は、それぞれの Amazon ECS に最適化された AMI バリアントのメタデータを取得する方法を示しています。

安定している最新の Amazon ECS に最適化された AMI メタデータを取得する

安定している最新の Amazon ECS に最適化された AMI を取得するには、AWS CLI で次の AWS CLI コマンドを使用します。

  • Amazon ECS に最適化された Windows Server 2022 Full AMI

    aws ssm get-parameters --names /aws/service/ami-windows-latest/Windows_Server-2022-English-Full-ECS_Optimized --region us-east-1

  • Amazon ECS に最適化された Windows Server 2022 Core AMI

    aws ssm get-parameters --names /aws/service/ami-windows-latest/Windows_Server-2022-English-Core-ECS_Optimized --region us-east-1

  • Amazon ECS に最適化された Windows Server 2019 Full AMI

    aws ssm get-parameters --names /aws/service/ami-windows-latest/Windows_Server-2019-English-Full-ECS_Optimized --region us-east-1

  • Amazon ECS に最適化された Windows Server 2019 Core AMI

    aws ssm get-parameters --names /aws/service/ami-windows-latest/Windows_Server-2019-English-Core-ECS_Optimized --region us-east-1

  • Amazon ECS に最適化された Windows Server 2016 Full AMI

    aws ssm get-parameters --names /aws/service/ami-windows-latest/Windows_Server-2016-English-Full-ECS_Optimized --region us-east-1

AWS CloudFormation テンプレートの推奨される最新の Amazon ECS に最適化された AMI を使用する

Systems Manager パラメータストア名を参照することにより、AWS CloudFormation テンプレートで推奨される最新の Amazon ECS に最適化された AMI を参照できます。

Parameters:
  LatestECSOptimizedAMI:
    Description: AMI ID
    Type: AWS::SSM::Parameter::Value<AWS::EC2::Image::Id>
    Default: /aws/service/ami-windows-latest/Windows_Server-2019-English-Full-ECS_Optimized/image_id