を使用した Image Builder の例 AWS CLI

次のコード例は、Image Builder AWS Command Line Interface で を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。

アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。

各例には、完全なソースコードへのリンクが含まれています。このリンクには、コンテキスト内でコードをセットアップして実行する方法の手順が記載されています。

アクション

create-component

次のコード例は、create-component を使用する方法を示しています。

AWS CLI

コンポーネントを作成するには

次のcreate-component例では、JSONドキュメントファイルを使用するコンポーネントを作成し、Amazon S3 バケットにアップロードされるYAML形式のコンポーネントドキュメントを参照します。

aws imagebuilder create-component \
    --cli-input-json file://create-component.json

create-component.json の内容:

{
    "name": "MyExampleComponent",
    "semanticVersion": "2019.12.02",
    "description": "An example component that builds, validates and tests an image",
    "changeDescription": "Initial version.",
    "platform": "Windows",
    "uri": "s3://s3-bucket-name/s3-bucket-path/component.yaml"
}

出力:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
    "componentBuildVersionArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/examplecomponent/2019.12.02/1"
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスCreateComponent」の「」を参照してください。 AWS CLI

create-distribution-configuration

次の例は、create-distribution-configuration を使用する方法を説明しています。

AWS CLI

ディストリビューション設定を作成するには

次のcreate-distribution-configuration例では、 JSON ファイルを使用してディストリビューション設定を作成します。

aws imagebuilder create-distribution-configuration \
    --cli-input-json file:/create-distribution-configuration.json

create-distribution-configuration.json の内容:

{
    "name": "MyExampleDistribution",
    "description": "Copies AMI to eu-west-1",
    "distributions": [
        {
            "region": "us-west-2",
            "amiDistributionConfiguration": {
                "name": "Name {{imagebuilder:buildDate}}",
                "description": "An example image name with parameter references",
                "amiTags": {
                    "KeyName": "{{ssm:parameter_name}}"
                },
                "launchPermission": {
                    "userIds": [
                        "123456789012"
                    ]
                }
            }
        },
        {
            "region": "eu-west-1",
            "amiDistributionConfiguration": {
                "name": "My {{imagebuilder:buildVersion}} image {{imagebuilder:buildDate}}",
                "amiTags": {
                    "KeyName": "Value"
                },
                "launchPermission": {
                    "userIds": [
                        "123456789012"
                    ]
                }
            }
        }
    ]
}

出力:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
    "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution"
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスCreateDistributionConfiguration」の「」を参照してください。 AWS CLI

create-image-pipeline

次のコード例は、create-image-pipeline を使用する方法を示しています。

AWS CLI

イメージパイプラインを作成するには

次のcreate-image-pipeline例では、 JSON ファイルを使用してイメージパイプラインを作成します。

aws imagebuilder create-image-pipeline \
    --cli-input-json file://create-image-pipeline.json

create-image-pipeline.json の内容:

{
    "name": "MyWindows2016Pipeline",
    "description": "Builds Windows 2016 Images",
    "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03",
    "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure",
    "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution",
    "imageTestsConfiguration": {
        "imageTestsEnabled": true,
        "timeoutMinutes": 60
    },
    "schedule": {
        "scheduleExpression": "cron(0 0 * * SUN)",
        "pipelineExecutionStartCondition": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE"
    },
    "status": "ENABLED"
}

出力:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
    "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline"
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスCreateImagePipeline」の「」を参照してください。 AWS CLI

create-image-recipe

次の例は、create-image-recipe を使用する方法を説明しています。

AWS CLI

レシピを作成するには

次のcreate-image-recipe例では、 JSON ファイルを使用してイメージレシピを作成します。コンポーネントは、指定された順序でインストールされます。

aws imagebuilder create-image-recipe \
    --cli-input-json file://create-image-recipe.json

create-image-recipe.json の内容:

{
    "name": "MyBasicRecipe",
    "description": "This example image recipe creates a Windows 2016 image.",
    "semanticVersion": "2019.12.03",
    "components":
    [
        {
            "componentArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myexamplecomponent/2019.12.02/1"
        },
        {
            "componentArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myimportedcomponent/1.0.0/1"
        }
    ],
    "parentImage": "arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/xxxx.x.x"
}

出力:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
    "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03"
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスCreateImageRecipe」の「」を参照してください。 AWS CLI

create-image

次の例は、create-image を使用する方法を説明しています。

AWS CLI

イメージを作成するには

次のcreate-image例では、イメージを作成します。

aws imagebuilder create-image \
    --image-recipe-arn arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03 \
    --infrastructure-configuration-arn arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure

出力:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
    "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1"
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスCreateImage」の「」を参照してください。 AWS CLI

create-infrastructure-configuration

次の例は、create-infrastructure-configuration を使用する方法を説明しています。

AWS CLI

インフラストラクチャ設定を作成するには

次のcreate-infrastructure-configuration例では、 JSON ファイルを使用してインフラストラクチャ設定を作成します。

aws imagebuilder create-infrastructure-configuration \
    --cli-input-json file://create-infrastructure-configuration.json

create-infrastructure-configuration.json の内容:

{
    "name": "MyExampleInfrastructure",
    "description": "An example that will retain instances of failed builds",
    "instanceTypes": [
        "m5.large", "m5.xlarge"
    ],
    "instanceProfileName": "EC2InstanceProfileForImageBuilder",
    "securityGroupIds": [
        "sg-a1b2c3d4"
    ],
    "subnetId": "subnet-a1b2c3d4",
    "logging": {
        "s3Logs": {
            "s3BucketName": "bucket-name",
            "s3KeyPrefix": "bucket-path"
        }
    },
    "keyPair": "key-pair-name",
    "terminateInstanceOnFailure": false,
    "snsTopicArn": "arn:aws:sns:us-west-2:123456789012:sns-topic-name"
}

出力:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
    "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure"
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスCreateInfrastructureConfiguration」の「」を参照してください。 AWS CLI

delete-component

次のコード例は、delete-component を使用する方法を示しています。

AWS CLI

コンポーネントを削除するには

次のdelete-component例では、 を指定してコンポーネントビルドバージョンを削除しますARN。

aws imagebuilder delete-component \
    --component-build-version-arn arn:aws:imagebuilder:us-west-2:123456789012:component/myexamplecomponent/2019.12.02/1

出力:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "componentBuildVersionArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myexamplecomponent/2019.12.02/1"
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスDeleteComponent」の「」を参照してください。 AWS CLI

delete-image-pipeline

次の例は、delete-image-pipeline を使用する方法を説明しています。

AWS CLI

イメージパイプラインを削除するには

次のdelete-image-pipeline例では、 を指定してイメージパイプラインを削除しますARN。

aws imagebuilder delete-image-pipeline \
    --image-pipeline-arn arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/my-example-pipeline

出力:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline"
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスDeleteImagePipeline」の「」を参照してください。 AWS CLI

delete-image-recipe

次のコード例は、delete-image-recipe を使用する方法を示しています。

AWS CLI

イメージレシピを削除するには

次のdelete-image-recipe例では、 を指定してイメージレシピを削除しますARN。

aws imagebuilder delete-image-recipe \
    --image-recipe-arn arn:aws:imagebuilder:us-east-1:123456789012:image-recipe/mybasicrecipe/2019.12.03

出力:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03"
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスDeleteImageRecipe」の「」を参照してください。 AWS CLI

delete-image

次のコード例は、delete-image を使用する方法を示しています。

AWS CLI

イメージを削除するには

次のdelete-image例では、 を指定してイメージビルドバージョンを削除しますARN。

aws imagebuilder delete-image \
    --image-build-version-arn arn:aws:imagebuilder:us-west-2:123456789012:image/my-example-image/2019.12.02/1

出力:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1"
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスDeleteImage」の「」を参照してください。 AWS CLI

delete-infrastructure-configuration

次の例は、delete-infrastructure-configuration を使用する方法を説明しています。

AWS CLI

インフラストラクチャ設定を削除するには

次のdelete-infrastructure-configuration例では、 を指定してイメージパイプラインを削除しますARN。

aws imagebuilder delete-infrastructure-configuration \
    --infrastructure-configuration-arn arn:aws:imagebuilder:us-east-1:123456789012:infrastructure-configuration/myexampleinfrastructure

出力:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure"
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスDeleteInfrastructureConfiguration」の「」を参照してください。 AWS CLI

get-component-policy

次のコード例は、get-component-policy を使用する方法を示しています。

AWS CLI

コンポーネントポリシーの詳細を取得するには

次のget-component-policy例では、 を指定してコンポーネントポリシーの詳細を一覧表示しますARN。

aws imagebuilder get-component-policy \
    --component-arn arn:aws:imagebuilder:us-west-2:123456789012:component/my-example-component/2019.12.03/1

出力:

{
    "Policy": "{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": [ "123456789012" ] }, "Action": [ "imagebuilder:GetComponent", "imagebuilder:ListComponents" ], "Resource": [ "arn:aws:imagebuilder:us-west-2:123456789012:component/my-example-component/2019.12.03/1" ] } ] }"
}

詳細については、EC2「Image Builder ユーザーガイド」の「＜https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html>`__ を使用した AWS CLI Image Builder イメージパイプラインのセットアップと管理」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスGetComponentPolicy」の「」を参照してください。 AWS CLI

get-component

次の例は、get-component を使用する方法を説明しています。

AWS CLI

コンポーネントの詳細を取得するには

次のget-component例では、 を指定してコンポーネントの詳細を一覧表示しますARN。

aws imagebuilder get-component \
    --component-build-version-arn arn:aws:imagebuilder:us-west-2:123456789012:component/component-name/1.0.0/1

出力:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "component": {
        "arn": "arn:aws:imagebuilder:us-west-2:123456789012:component/component-name/1.0.0/1",
        "name": "component-name",
        "version": "1.0.0",
        "type": "TEST",
        "platform": "Linux",
        "owner": "123456789012",
        "data": "name: HelloWorldTestingDocument\ndescription: This is hello world testing document.\nschemaVersion: 1.0\n\nphases:\n  - name: test\n    steps:\n      - name: HelloWorldStep\n        action: ExecuteBash\n        inputs:\n          commands:\n            - echo \"Hello World! Test.\"\n",
        "encrypted": true,
        "dateCreated": "2020-01-27T20:43:30.306Z",
        "tags": {}
    }
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスGetComponent」の「」を参照してください。 AWS CLI

get-distribution-configuration

次の例は、get-distribution-configuration を使用する方法を説明しています。

AWS CLI

ディストリビューション設定の詳細を取得するには

次のget-distribution-configuration例では、 を指定してディストリビューション設定の詳細を表示しますARN。

aws imagebuilder get-distribution-configuration \
    --distribution-configuration-arn arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution

出力:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "distributionConfiguration": {
        "arn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution",
        "name": "MyExampleDistribution",
        "description": "Copies AMI to eu-west-1 and exports to S3",
        "distributions": [
            {
                "region": "us-west-2",
                "amiDistributionConfiguration": {
                    "name": "Name {{imagebuilder:buildDate}}",
                    "description": "An example image name with parameter references",
                    "amiTags": {
                        "KeyName": "{{ssm:parameter_name}}"
                    },
                    "launchPermission": {
                        "userIds": [
                            "123456789012"
                        ]
                    }
                }
            },
            {
                "region": "eu-west-1",
                "amiDistributionConfiguration": {
                    "name": "My {{imagebuilder:buildVersion}} image {{imagebuilder:buildDate}}",
                    "amiTags": {
                        "KeyName": "Value"
                    },
                    "launchPermission": {
                        "userIds": [
                            "123456789012"
                        ]
                    }
                }
            }
        ],
        "dateCreated": "2020-02-19T18:40:10.529Z",
        "tags": {}
    }
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスGetDistributionConfiguration」の「」を参照してください。 AWS CLI

get-image-pipeline

次のコード例は、get-image-pipeline を使用する方法を示しています。

AWS CLI

イメージパイプラインの詳細を取得するには

次のget-image-pipeline例では、 を指定してイメージパイプラインの詳細を一覧表示しますARN。

aws imagebuilder get-image-pipeline \
    --image-pipeline-arn arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline

出力:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "imagePipeline": {
        "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline",
        "name": "MyWindows2016Pipeline",
        "description": "Builds Windows 2016 Images",
        "platform": "Windows",
        "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03",
        "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure",
        "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution",
        "imageTestsConfiguration": {
            "imageTestsEnabled": true,
            "timeoutMinutes": 60
        },
        "schedule": {
            "scheduleExpression": "cron(0 0 * * SUN)",
            "pipelineExecutionStartCondition": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE"
        },
        "status": "ENABLED",
        "dateCreated": "2020-02-19T19:04:01.253Z",
        "dateUpdated": "2020-02-19T19:04:01.253Z",
        "tags": {}
    }
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスGetImagePipeline」の「」を参照してください。 AWS CLI

get-image-policy

次の例は、get-image-policy を使用する方法を説明しています。

AWS CLI

イメージポリシーの詳細を取得するには

次のget-image-policy例では、 を指定してイメージポリシーの詳細を一覧表示しますARN。

aws imagebuilder get-image-policy \
    --image-arn arn:aws:imagebuilder:us-west-2:123456789012:image/my-example-image/2019.12.03/1

出力:

{
    "Policy": "{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": [ "123456789012" ] }, "Action": [ "imagebuilder:GetImage", "imagebuilder:ListImages" ], "Resource": [ "arn:aws:imagebuilder:us-west-2:123456789012:image/my-example-image/2019.12.03/1" ] } ] }"
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスGetImagePolicy」の「」を参照してください。 AWS CLI

get-image-recipe-policy

次の例は、get-image-recipe-policy を使用する方法を説明しています。

AWS CLI

イメージレシピポリシーの詳細を取得するには

次のget-image-recipe-policy例では、 を指定してイメージレシピポリシーの詳細を一覧表示しますARN。

aws imagebuilder get-image-recipe-policy \
    --image-recipe-arn arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/my-example-image-recipe/2019.12.03/1

出力:

{
    "Policy": "{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": [ "123456789012" ] }, "Action": [ "imagebuilder:GetImageRecipe", "imagebuilder:ListImageRecipes" ], "Resource": [ "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/my-example-image-recipe/2019.12.03/1" ] } ] }"
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスGetImageRecipePolicy」の「」を参照してください。 AWS CLI

get-image

次の例は、get-image を使用する方法を説明しています。

AWS CLI

イメージの詳細を取得するには

次のget-image例では、 を指定してイメージの詳細を一覧表示しますARN。

aws imagebuilder get-image \
    --image-build-version-arn arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1

出力:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "image": {
        "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1",
        "name": "MyBasicRecipe",
        "version": "2019.12.03/1",
        "platform": "Windows",
        "state": {
            "status": "BUILDING"
        },
        "imageRecipe": {
            "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03",
            "name": "MyBasicRecipe",
            "description": "This example image recipe creates a Windows 2016 image.",
            "platform": "Windows",
            "version": "2019.12.03",
            "components": [
                {
                    "componentArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myexamplecomponent/2019.12.02/1"
                },
                {
                    "componentArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myimportedcomponent/1.0.0/1"
                }
            ],
            "parentImage": "arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/2019.12.17/1",
            "dateCreated": "2020-02-14T19:46:16.904Z",
            "tags": {}
        },
        "infrastructureConfiguration": {
            "arn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure",
            "name": "MyExampleInfrastructure",
            "description": "An example that will retain instances of failed builds",
            "instanceTypes": [
                "m5.large",
                "m5.xlarge"
            ],
            "instanceProfileName": "EC2InstanceProfileForImageFactory",
            "securityGroupIds": [
                "sg-a1b2c3d4"
            ],
            "subnetId": "subnet-a1b2c3d4",
            "logging": {
                "s3Logs": {
                    "s3BucketName": "bucket-name",
                    "s3KeyPrefix": "bucket-path"
                }
            },
            "keyPair": "Sam",
            "terminateInstanceOnFailure": false,
            "snsTopicArn": "arn:aws:sns:us-west-2:123456789012:sns-name",
            "dateCreated": "2020-02-14T21:21:05.098Z",
            "tags": {}
        },
        "imageTestsConfiguration": {
            "imageTestsEnabled": true,
            "timeoutMinutes": 720
        },
        "dateCreated": "2020-02-14T23:14:13.597Z",
        "outputResources": {
            "amis": []
        },
        "tags": {}
    }
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスGetImage」の「」を参照してください。 AWS CLI

get-infrastructure-configuration

次の例は、get-infrastructure-configuration を使用する方法を説明しています。

AWS CLI

インフラストラクチャ設定の詳細を取得するには

次のget-infrastructure-configuration例では、 を指定してインフラストラクチャ設定の詳細を一覧表示しますARN。

aws imagebuilder get-infrastructure-configuration \
    --infrastructure-configuration-arn arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure

出力:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "infrastructureConfiguration": {
        "arn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure",
        "name": "MyExampleInfrastructure",
        "description": "An example that will retain instances of failed builds",
        "instanceTypes": [
            "m5.large",
            "m5.xlarge"
        ],
        "instanceProfileName": "EC2InstanceProfileForImageBuilder",
        "securityGroupIds": [
            "sg-a48c95ef"
        ],
        "subnetId": "subnet-a48c95ef",
        "logging": {
            "s3Logs": {
                "s3BucketName": "bucket-name",
                "s3KeyPrefix": "bucket-path"
            }
        },
        "keyPair": "Name",
        "terminateInstanceOnFailure": false,
        "snsTopicArn": "arn:aws:sns:us-west-2:123456789012:sns-name",
        "dateCreated": "2020-02-19T19:11:51.858Z",
        "tags": {}
    }
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスGetInfrastructureConfiguration」の「」を参照してください。 AWS CLI

import-component

次の例は、import-component を使用する方法を説明しています。

AWS CLI

コンポーネントをインポートするには

次のimport-component例では、 JSON ファイルを使用して既存のスクリプトをインポートします。

aws imagebuilder import-component \
    --cli-input-json file://import-component.json

import-component.json の内容:

{
    "name": "MyImportedComponent",
    "semanticVersion": "1.0.0",
    "description": "An example of how to import a component",
    "changeDescription": "First commit message.",
    "format": "SHELL",
    "platform": "Windows",
    "type": "BUILD",
    "uri": "s3://s3-bucket-name/s3-bucket-path/component.yaml"
}

出力:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
    "componentBuildVersionArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myimportedcomponent/1.0.0/1"
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスImportComponent」の「」を参照してください。 AWS CLI

list-component-build-versions

次のコード例は、list-component-build-versions を使用する方法を示しています。

AWS CLI

コンポーネントビルドバージョンを一覧表示するには

次のlist-component-build-versions例では、特定のセマンティックバージョンを持つコンポーネントビルドバージョンを一覧表示します。

aws imagebuilder list-component-build-versions --component-version-arn arn:aws:imagebuilder:us-west-2:123456789012:component/myexamplecomponent/2019.12.02

出力:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "componentSummaryList": [
        {
            "arn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myexamplecomponent/2019.12.02/1",
            "name": "MyExampleComponent",
            "version": "2019.12.02",
            "platform": "Windows",
            "type": "BUILD",
            "owner": "123456789012",
            "description": "An example component that builds, validates and tests an image",
            "changeDescription": "Initial version.",
            "dateCreated": "2020-02-19T18:53:45.940Z",
            "tags": {
                "KeyName": "KeyValue"
            }
        }
    ]
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスListComponentBuildVersions」の「」を参照してください。 AWS CLI

list-components

次の例は、list-components を使用する方法を説明しています。

AWS CLI

すべてのコンポーネントセマンティックバージョンを一覧表示するには

次のlist-components例では、アクセスできるすべてのコンポーネントセマンティックバージョンを一覧表示します。オプションで、自分が所有するコンポーネント、Amazon が所有するコンポーネント、または他のアカウントによって共有されているコンポーネントを一覧表示するかどうかをフィルタリングできます。

aws imagebuilder list-components

出力:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "componentVersionList": [
        {
            "arn": "arn:aws:imagebuilder:us-west-2:123456789012:component/component-name/1.0.0",
            "name": "component-name",
            "version": "1.0.0",
            "platform": "Linux",
            "type": "TEST",
            "owner": "123456789012",
            "dateCreated": "2020-01-27T20:43:30.306Z"
        }
    ]
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスListComponents」の「」を参照してください。 AWS CLI

list-distribution-configurations

次の例は、list-distribution-configurations を使用する方法を説明しています。

AWS CLI

ディストリビューションを一覧表示するには

次のlist-distribution-configurations例では、すべてのディストリビューションを一覧表示します。

aws imagebuilder list-distribution-configurations

出力:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "distributionConfigurationSummaryList": [
        {
            "arn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution",
            "name": "MyExampleDistribution",
            "description": "Copies AMI to eu-west-1 and exports to S3",
            "dateCreated": "2020-02-19T18:40:10.529Z",
            "tags": {
                "KeyName": "KeyValue"
            }
        }
    ]
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスListDistributionConfigurations」の「」を参照してください。 AWS CLI

list-image-build-versions

次のコード例は、list-image-build-versions を使用する方法を示しています。

AWS CLI

イメージビルドバージョンを一覧表示するには

次のlist-image-build-versions例では、すべてのイメージビルドバージョンをセマンティックバージョンで一覧表示します。

aws imagebuilder list-image-build-versions \
    --image-version-arn arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03

出力:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "imageSummaryList": [
        {
            "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/7",
            "name": "MyBasicRecipe",
            "version": "2019.12.03/7",
            "platform": "Windows",
            "state": {
                "status": "FAILED",
                "reason": "Can't start SSM Automation for arn arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/7 during building. Parameter \"iamInstanceProfileName\" has a null value."
            },
            "owner": "123456789012",
            "dateCreated": "2020-02-19T18:56:11.511Z",
            "outputResources": {
                "amis": []
            },
            "tags": {}
        },
        {
            "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/6",
            "name": "MyBasicRecipe",
            "version": "2019.12.03/6",
            "platform": "Windows",
            "state": {
                "status": "FAILED",
                "reason": "An internal error has occurred."
            },
            "owner": "123456789012",
            "dateCreated": "2020-02-18T22:49:08.142Z",
            "outputResources": {
                "amis": [
                    {
                        "region": "us-west-2",
                        "image": "ami-a1b2c3d4567890ab",
                        "name": "MyBasicRecipe 2020-02-18T22-49-38.704Z",
                        "description": "This example image recipe creates a Windows 2016 image."
                    },
                    {
                        "region": "us-west-2",
                        "image": "ami-a1b2c3d4567890ab",
                        "name": "Name 2020-02-18T22-49-08.131Z",
                        "description": "Copies AMI to eu-west-2 and exports to S3"
                    },
                    {
                        "region": "eu-west-2",
                        "image": "ami-a1b2c3d4567890ab",
                        "name": "My 6 image 2020-02-18T22-49-08.131Z",
                        "description": "Copies AMI to eu-west-2 and exports to S3"
                    }
                ]
            },
            "tags": {}
        },
        {
            "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/5",
            "name": "MyBasicRecipe",
            "version": "2019.12.03/5",
            "platform": "Windows",
            "state": {
                "status": "AVAILABLE"
            },
            "owner": "123456789012",
            "dateCreated": "2020-02-18T16:51:48.403Z",
            "outputResources": {
                "amis": [
                    {
                        "region": "us-west-2",
                        "image": "ami-a1b2c3d4567890ab",
                        "name": "MyBasicRecipe 2020-02-18T16-52-18.965Z",
                        "description": "This example image recipe creates a Windows 2016 image."
                    }
                ]
            },
            "tags": {}
        },
        {
            "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/4",
            "name": "MyBasicRecipe",
            "version": "2019.12.03/4",
            "platform": "Windows",
            "state": {
                "status": "AVAILABLE"
            },
            "owner": "123456789012",
            "dateCreated": "2020-02-18T16:50:01.827Z",
            "outputResources": {
                "amis": [
                    {
                        "region": "us-west-2",
                        "image": "ami-a1b2c3d4567890ab",
                        "name": "MyBasicRecipe 2020-02-18T16-50-32.280Z",
                        "description": "This example image recipe creates a Windows 2016 image."
                    }
                ]
            },
            "tags": {}
        },
        {
            "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/3",
            "name": "MyBasicRecipe",
            "version": "2019.12.03/3",
            "platform": "Windows",
            "state": {
                "status": "AVAILABLE"
            },
            "owner": "123456789012",
            "dateCreated": "2020-02-14T23:14:13.597Z",
            "outputResources": {
                "amis": [
                    {
                        "region": "us-west-2",
                        "image": "ami-a1b2c3d4567890ab",
                        "name": "MyBasicRecipe 2020-02-14T23-14-44.243Z",
                        "description": "This example image recipe creates a Windows 2016 image."
                    }
                ]
            },
            "tags": {}
        },
        {
            "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/2",
            "name": "MyBasicRecipe",
            "version": "2019.12.03/2",
            "platform": "Windows",
            "state": {
                "status": "FAILED",
                "reason": "SSM execution 'a1b2c3d4-5678-90ab-cdef-EXAMPLE11111' failed with status = 'Failed' and failure message = 'Step fails when it is verifying the command has completed. Command a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 returns unexpected invocation result: \n{Status=[Failed], ResponseCode=[1], Output=[\n----------ERROR-------\nfailed to run commands: exit status 1], OutputPayload=[{\"Status\":\"Failed\",\"ResponseCode\":1,\"Output\":\"\\n----------ERROR-------\\nfailed to run commands: exit status 1\",\"CommandId\":\"a1b2c3d4-5678-90ab-cdef-EXAMPLE11111\"}], CommandId=[a1b2c3d4-5678-90ab-cdef-EXAMPLE11111]}. Please refer to Automation Service Troubleshooting Guide for more diagnosis details.'"
            },
            "owner": "123456789012",
            "dateCreated": "2020-02-14T22:57:42.593Z",
            "outputResources": {
                "amis": []
            },
            "tags": {}
        }
    ]
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスListImageBuildVersions」の「」を参照してください。 AWS CLI

list-image-pipeline-images

次の例は、list-image-pipeline-images を使用する方法を説明しています。

AWS CLI

イメージパイプラインパイプラインイメージを一覧表示するには

次のlist-image-pipeline-images例では、特定のイメージパイプラインによって作成されたすべてのイメージを一覧表示します。

aws imagebuilder list-image-pipeline-images \
    --image-pipeline-arn arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline

出力:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "imagePipelineList": [
        {
            "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline",
            "name": "MyWindows2016Pipeline",
            "description": "Builds Windows 2016 Images",
            "platform": "Windows",
            "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03",
            "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure",
            "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution",
            "imageTestsConfiguration": {
                "imageTestsEnabled": true,
                "timeoutMinutes": 60
            },
            "schedule": {
                "scheduleExpression": "cron(0 0 * * SUN)",
                "pipelineExecutionStartCondition": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE"
            },
            "status": "ENABLED",
            "dateCreated": "2020-02-19T19:04:01.253Z",
            "dateUpdated": "2020-02-19T19:04:01.253Z",
            "tags": {
                "KeyName": "KeyValue"
            }
        },
        {
            "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/sam",
            "name": "PipelineName",
            "platform": "Linux",
            "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/recipe-name-a1b2c3d45678/1.0.0",
            "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/infrastructureconfiguration-name-a1b2c3d45678",
            "imageTestsConfiguration": {
                "imageTestsEnabled": true,
                "timeoutMinutes": 720
            },
            "status": "ENABLED",
            "dateCreated": "2019-12-16T18:19:02.068Z",
            "dateUpdated": "2019-12-16T18:19:02.068Z",
            "tags": {
                "KeyName": "KeyValue"
            }
        }
    ]
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスListImagePipelineImages」の「」を参照してください。 AWS CLI

list-image-recipes

次のコード例は、list-image-recipes を使用する方法を示しています。

AWS CLI

イメージレシピを一覧表示するには

次のlist-image-recipes例では、すべてのイメージレシピを一覧表示します。

aws imagebuilder list-image-recipes

出力:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "imageRecipeSummaryList": [
        {
            "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03",
            "name": "MyBasicRecipe",
            "platform": "Windows",
            "owner": "123456789012",
            "parentImage": "arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/2019.x.x",
            "dateCreated": "2020-02-19T18:54:25.975Z",
            "tags": {
                "KeyName": "KeyValue"
            }
        },
        {
            "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/recipe-name-a1b2c3d45678/1.0.0",
            "name": "recipe-name-a1b2c3d45678",
            "platform": "Linux",
            "owner": "123456789012",
            "parentImage": "arn:aws:imagebuilder:us-west-2:aws:image/amazon-linux-2-x86/2019.11.21",
            "dateCreated": "2019-12-16T18:19:00.120Z",
            "tags": {
                "KeyName": "KeyValue"
            }
        }
    ]
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスListImageRecipes」の「」を参照してください。 AWS CLI

list-images

次のコード例は、list-images を使用する方法を示しています。

AWS CLI

イメージを一覧表示するには

次のlist-images例では、アクセスできるすべてのセマンティックバージョンを一覧表示します。

aws imagebuilder list-images

出力:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "imageVersionList": [
        {
            "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03",
            "name": "MyBasicRecipe",
            "version": "2019.12.03",
            "platform": "Windows",
            "owner": "123456789012",
            "dateCreated": "2020-02-14T21:29:18.810Z"
        }
    ]
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスListImages」の「」を参照してください。 AWS CLI

list-infrastructure-configurations

次のコード例は、list-infrastructure-configurations を使用する方法を示しています。

AWS CLI

インフラストラクチャ設定を一覧表示するには

次のlist-infrastructure-configurations例では、すべてのインフラストラクチャ設定を一覧表示します。

aws imagebuilder list-infrastructure-configurations

出力:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "infrastructureConfigurationSummaryList": [
        {
            "arn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure",
            "name": "MyExampleInfrastructure",
            "description": "An example that will retain instances of failed builds",
            "dateCreated": "2020-02-19T19:11:51.858Z",
            "tags": {}
        },
        {
            "arn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/infrastructureconfiguration-name-a1b2c3d45678",
            "name": "infrastructureConfiguration-name-a1b2c3d45678",
            "dateCreated": "2019-12-16T18:19:01.038Z",
            "tags": {
                "KeyName": "KeyValue"
            }
        }
    ]
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスListInfrastructureConfigurations」の「」を参照してください。 AWS CLI

list-tags-for-resource

次のコード例は、list-tags-for-resource を使用する方法を示しています。

AWS CLI

特定のリソースのタグを一覧表示するには

次のlist-tags-for-resource例では、特定のリソースのすべてのタグを一覧表示します。

aws imagebuilder list-tags-for-resource \
    --resource-arn arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline

出力:

{
    "tags": {
        "KeyName": "KeyValue"
    }
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスListTagsForResource」の「」を参照してください。 AWS CLI

put-component-policy

次の例は、put-component-policy を使用する方法を説明しています。

AWS CLI

リソースポリシーをコンポーネントに適用するには

次のput-component-policyコマンドは、ビルドコンポーネントにリソースポリシーを適用して、ビルドコンポーネントのクロスアカウント共有を有効にします。RAM CLI コマンド を使用することをお勧めしますcreate-resource-share。EC2 Image Builder CLI コマンド を使用する場合はput-component-policy、リソースを共有しているすべてのプリンシパルpromote-resource-share-create-from-policyにリソースを表示するには、 RAM CLI コマンドも使用する必要があります。

aws imagebuilder put-component-policy \
    --component-arn arn:aws:imagebuilder:us-west-2:123456789012:component/examplecomponent/2019.12.02/1 \
    --policy '{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": [ "123456789012" ] }, "Action": [ "imagebuilder:GetComponent", "imagebuilder:ListComponents" ], "Resource": [ "arn:aws:imagebuilder:us-west-2:123456789012:component/examplecomponent/2019.12.02/1" ] } ] }'

出力:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "componentArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/examplecomponent/2019.12.02/1"
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスPutComponentPolicy」の「」を参照してください。 AWS CLI

put-image-policy

次の例は、put-image-policy を使用する方法を説明しています。

AWS CLI

リソースポリシーをイメージに適用するには

次のput-image-policyコマンドは、リソースポリシーをイメージに適用して、イメージのクロスアカウント共有を有効にします。RAM CLI コマンド を使用することをお勧めします create-resource-share。EC2 Image Builder CLI コマンド を使用する場合は put-image-policy、リソースを共有しているすべてのプリンシパルにリソースを表示するには、 RAM CLI コマンド promote-resource-share-create-from-policy も使用する必要があります。

aws imagebuilder put-image-policy \
    --image-arn arn:aws:imagebuilder:us-west-2:123456789012:image/example-image/2019.12.02/1 \
    --policy '{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": [ "123456789012" ] }, "Action": [ "imagebuilder:GetImage", "imagebuilder:ListImages" ], "Resource": [ "arn:aws:imagebuilder:us-west-2:123456789012:image/example-image/2019.12.02/1" ] } ] }'

出力:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "imageArn": "arn:aws:imagebuilder:us-west-2:123456789012:image/example-image/2019.12.02/1"
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスPutImagePolicy」の「」を参照してください。 AWS CLI

put-image-recipe-policy

次の例は、put-image-recipe-policy を使用する方法を説明しています。

AWS CLI

リソースポリシーをイメージレシピに適用するには

次のput-image-recipe-policyコマンドは、イメージレシピにリソースポリシーを適用して、イメージレシピのクロスアカウント共有を有効にします。RAM CLI コマンド を使用することをお勧めしますcreate-resource-share。EC2 Image Builder CLI コマンド を使用する場合はput-image-recipe-policy、リソースを共有しているすべてのプリンシパルpromote-resource-share-create-from-policyにリソースを表示するには、 RAM CLI コマンドも使用する必要があります。

aws imagebuilder put-image-recipe-policy \
    --image-recipe-arn arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/example-image-recipe/2019.12.02 \
    --policy '{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": [ "123456789012" ] }, "Action": [ "imagebuilder:GetImageRecipe", "imagebuilder:ListImageRecipes" ], "Resource": [ "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/example-image-recipe/2019.12.02" ] } ] }'

出力:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/example-image-recipe/2019.12.02/1"
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスPutImageRecipePolicy」の「」を参照してください。 AWS CLI

start-image-pipeline-execution

次のコード例は、start-image-pipeline-execution を使用する方法を示しています。

AWS CLI

イメージパイプラインを手動で開始するには

次のstart-image-pipeline-execution例では、イメージパイプラインを手動で開始します。

aws imagebuilder start-image-pipeline-execution \
    --image-pipeline-arn arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline

出力:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
    "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1"
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスStartImagePipelineExecution」の「」を参照してください。 AWS CLI

tag-resource

次のコード例は、tag-resource を使用する方法を示しています。

AWS CLI

リソースにタグを付けるには

次のtag-resource例では、 JSON ファイルを使用してリソースを EC2 Image Builder に追加し、タグ付けします。

aws imagebuilder tag-resource \
    --cli-input-json file://tag-resource.json

tag-resource.json の内容:

{
    "resourceArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline",
    "tags": {
        "KeyName: "KeyValue"
    }
}

このコマンドでは何も出力されません。

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスTagResource」の「」を参照してください。 AWS CLI

untag-resource

次の例は、untag-resource を使用する方法を説明しています。

AWS CLI

リソースからタグを削除するには

次のuntag-resource例では、 JSON ファイルを使用してリソースからタグを削除します。

aws imagebuilder untag-resource \
    --cli-input-json file://tag-resource.json

untag-resource.json の内容:

{
    "resourceArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline",
    "tagKeys": [
        "KeyName"
    ]
}

このコマンドでは何も出力されません。

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスUntagResource」の「」を参照してください。 AWS CLI

update-distribution-configuration

次の例は、update-distribution-configuration を使用する方法を説明しています。

AWS CLI

ディストリビューション設定を更新するには

次のupdate-distribution-configuration例では、 JSON ファイルを使用してディストリビューション設定を更新します。

aws imagebuilder update-distribution-configuration \
    --cli-input-json file://update-distribution-configuration.json

update-distribution-configuration.json の内容:

{
    "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution",
    "description": "Copies AMI to eu-west-2 and exports to S3",
    "distributions": [
        {
            "region": "us-west-2",
            "amiDistributionConfiguration": {
                "name": "Name {{imagebuilder:buildDate}}",
                "description": "An example image name with parameter references"
            }
        },
        {
            "region": "eu-west-2",
            "amiDistributionConfiguration": {
                "name": "My {{imagebuilder:buildVersion}} image {{imagebuilder:buildDate}}"
            }
        }
    ]
}

出力:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスUpdateDistributionConfiguration」の「」を参照してください。 AWS CLI

update-image-pipeline

次のコード例は、update-image-pipeline を使用する方法を示しています。

AWS CLI

イメージパイプラインを更新するには

次のupdate-image-pipeline例では、 JSON ファイルを使用してイメージパイプラインを更新します。

aws imagebuilder update-image-pipeline \
    --cli-input-json file://update-image-pipeline.json

update-image-pipeline.json の内容:

{
    "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline",
    "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03",
    "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure",
    "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution",
    "imageTestsConfiguration": {
        "imageTestsEnabled": true,
        "timeoutMinutes": 120
    },
    "schedule": {
        "scheduleExpression": "cron(0 0 * * MON)",
        "pipelineExecutionStartCondition": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE"
    },
    "status": "DISABLED"
}

出力:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスUpdateImagePipeline」の「」を参照してください。 AWS CLI

update-infrastructure-configuration

次のコード例は、update-infrastructure-configuration を使用する方法を示しています。

AWS CLI

インフラストラクチャ設定を更新するには

次のupdate-infrastructure-configuration例では、 JSON ファイルを使用してインフラストラクチャ設定を更新します。

aws imagebuilder update-infrastructure-configuration \
    --cli-input-json file:/update-infrastructure-configuration.json

update-infrastructure-configuration.json の内容:

{
    "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure",
    "description": "An example that will terminate instances of failed builds",
    "instanceTypes": [
        "m5.large", "m5.2xlarge"
    ],
    "instanceProfileName": "EC2InstanceProfileForImageFactory",
    "securityGroupIds": [
        "sg-a48c95ef"
    ],
    "subnetId": "subnet-a48c95ef",
    "logging": {
        "s3Logs": {
            "s3BucketName": "bucket-name",
            "s3KeyPrefix": "bucket-path"
        }
    },
    "terminateInstanceOnFailure": true,
    "snsTopicArn": "arn:aws:sns:us-west-2:123456789012:sns-name"
}

出力:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}

詳細については、EC2「Image Builder ユーザーガイド」の「 を使用した Image Builder イメージパイプラインのセットアップと管理 AWS CLI」を参照してください。 EC2

• API 詳細については、「 コマンドリファレンスUpdateInfrastructureConfiguration」の「」を参照してください。 AWS CLI