Exemples d'Image Builder utilisant AWS CLI

Les exemples de code suivants vous montrent comment effectuer des actions et implémenter des scénarios courants à l'aide de AWS Command Line Interface with Image Builder.

Les actions sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.

Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la façon de configurer et d'exécuter le code en contexte.

Rubriques

Actions

Actions

L'exemple de code suivant montre comment utilisercreate-component.

AWS CLI

Pour créer un composant

L'create-componentexemple suivant crée un composant qui utilise un fichier de document JSON et fait référence à un document de composant au format YAML qui est chargé dans un compartiment Amazon S3.


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

Contenu de 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"
}

Sortie :


{
    "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"
}

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, reportez-vous CreateComponentà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-distribution-configuration.

AWS CLI

Pour créer une configuration de distribution

L'create-distribution-configurationexemple suivant crée une configuration de distribution à l'aide d'un fichier JSON.


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

Contenu de 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"
                    ]
                }
            }
        }
    ]
}

Sortie :


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

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, reportez-vous CreateDistributionConfigurationà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-image-pipeline.

AWS CLI

Pour créer un pipeline d'images

L'create-image-pipelineexemple suivant crée un pipeline d'images à l'aide d'un fichier JSON.


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

Contenu de 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"
}

Sortie :


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

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, reportez-vous CreateImagePipelineà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-image-recipe.

AWS CLI

Pour créer une recette

L'create-image-recipeexemple suivant crée une recette d'image à l'aide d'un fichier JSON. Les composants sont installés dans l'ordre dans lequel ils sont spécifiés.


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

Contenu de 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"
}

Sortie :


{
    "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"
}

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, reportez-vous CreateImageRecipeà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-image.

AWS CLI

Pour créer une image

L'create-imageexemple suivant crée une 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

Sortie :


{
    "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"
}

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, reportez-vous CreateImageà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-infrastructure-configuration.

AWS CLI

Pour créer une configuration d'infrastructure

L'create-infrastructure-configurationexemple suivant crée une configuration d'infrastructure à l'aide d'un fichier JSON.


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

Contenu de 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"
}

Sortie :


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

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, reportez-vous CreateInfrastructureConfigurationà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-component.

AWS CLI

Pour supprimer un composant

L'delete-componentexemple suivant supprime une version de construction d'un composant en spécifiant son ARN.


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

Sortie :


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

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, reportez-vous DeleteComponentà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-image-pipeline.

AWS CLI

Pour supprimer un pipeline d'images

L'delete-image-pipelineexemple suivant supprime un pipeline d'images en spécifiant son ARN.


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

Sortie :


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

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, reportez-vous DeleteImagePipelineà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-image-recipe.

AWS CLI

Pour supprimer une recette imagée

L'delete-image-recipeexemple suivant supprime une recette d'image en spécifiant son ARN.


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

Sortie :


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

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, reportez-vous DeleteImageRecipeà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-image.

AWS CLI

Pour supprimer une image

L'delete-imageexemple suivant supprime une version de génération d'image en spécifiant son ARN.


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

Sortie :


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

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, reportez-vous DeleteImageà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-infrastructure-configuration.

AWS CLI

Pour supprimer une configuration d'infrastructure

L'delete-infrastructure-configurationexemple suivant supprime un pipeline d'images en spécifiant son ARN.


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

Sortie :


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

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, reportez-vous DeleteInfrastructureConfigurationà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-component-policy.

AWS CLI

Pour obtenir les détails de la politique relative aux composants

L'get-component-policyexemple suivant répertorie les détails d'une politique de composant en spécifiant son ARN.


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

Sortie :


{
    "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" ] } ] }"
}

Pour plus d'informations, consultez Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI < https://docs.aws.amazon.com/imagebuilder/ latest/userguide/managing - image-builder-cli .html>`__ dans le guide de l'utilisateur d'EC2 Image Builder.

Pour plus de détails sur l'API, reportez-vous GetComponentPolicyà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-component.

AWS CLI

Pour obtenir des informations détaillées sur les composants

L'get-componentexemple suivant répertorie les détails d'un composant en spécifiant son ARN.


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

Sortie :


{
    "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": {}
    }
}

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, reportez-vous GetComponentà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-distribution-configuration.

AWS CLI

Pour obtenir les détails d'une configuration de distribution

L'get-distribution-configurationexemple suivant affiche les détails d'une configuration de distribution en spécifiant son ARN.


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

Sortie :


{
    "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": {}
    }
}

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, reportez-vous GetDistributionConfigurationà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-image-pipeline.

AWS CLI

Pour obtenir les détails du pipeline d'images

L'get-image-pipelineexemple suivant répertorie les détails d'un pipeline d'images en spécifiant son ARN.


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

Sortie :


{
    "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": {}
    }
}

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, reportez-vous GetImagePipelineà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-image-policy.

AWS CLI

Pour obtenir des informations sur la politique en matière d'images

L'get-image-policyexemple suivant répertorie les détails d'une politique d'image en spécifiant son ARN.


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

Sortie :


{
    "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" ] } ] }"
}

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, reportez-vous GetImagePolicyà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-image-recipe-policy.

AWS CLI

Pour obtenir les détails de la politique en matière de recettes illustrées

L'get-image-recipe-policyexemple suivant répertorie les détails d'une politique de recette d'image en spécifiant son 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

Sortie :


{
    "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" ] } ] }"
}

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, reportez-vous GetImageRecipePolicyà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-image.

AWS CLI

Pour obtenir les détails de l'image

L'get-imageexemple suivant répertorie les détails d'une image en spécifiant son ARN.


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

Sortie :


{
    "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": {}
    }
}

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, reportez-vous GetImageà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-infrastructure-configuration.

AWS CLI

Pour obtenir les détails de configuration de l'infrastructure

L'get-infrastructure-configurationexemple suivant répertorie les détails d'une configuration d'infrastructure en spécifiant son ARN.


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

Sortie :


{
    "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": {}
    }
}

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, reportez-vous GetInfrastructureConfigurationà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserimport-component.

AWS CLI

Pour importer un composant

L'import-componentexemple suivant importe un script préexistant à l'aide d'un fichier JSON.


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

Contenu de 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"
}

Sortie :


{
    "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"
}

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, reportez-vous ImportComponentà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-component-build-versions.

AWS CLI

Pour répertorier les versions de construction des composants

L'list-component-build-versionsexemple suivant répertorie les versions de construction des composants avec une version sémantique spécifique.


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

Sortie :


{
    "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"
            }
        }
    ]
}

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, reportez-vous ListComponentBuildVersionsà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-components.

AWS CLI

Pour répertorier toutes les versions sémantiques des composants

L'list-componentsexemple suivant répertorie toutes les versions sémantiques des composants auxquelles vous avez accès. Vous pouvez éventuellement filtrer les composants qui vous appartiennent, ceux d'Amazon ou ceux qui ont été partagés avec vous par d'autres comptes.


aws imagebuilder list-components

Sortie :


{
    "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"
        }
    ]
}

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, reportez-vous ListComponentsà la section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-distribution-configurations.

AWS CLI

Pour répertorier les distributions

L'list-distribution-configurationsexemple suivant répertorie toutes vos distributions.


aws imagebuilder list-distribution-configurations

Sortie :


{
    "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"
            }
        }
    ]
}

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, voir ListDistributionConfigurationsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-image-build-versions.

AWS CLI

Pour répertorier les versions de génération d'images

L'list-image-build-versionsexemple suivant répertorie toutes les versions de génération d'image avec une version sémantique.


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

Sortie :


{
    "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": {}
        }
    ]
}

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, voir ListImageBuildVersionsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-image-pipeline-images.

AWS CLI

Pour répertorier les images du pipeline d'images

L'list-image-pipeline-imagesexemple suivant répertorie toutes les images créées par un pipeline d'images spécifique.


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

Sortie :


{
    "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"
            }
        }
    ]
}

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, voir ListImagePipelineImagesla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-image-recipes.

AWS CLI

Pour répertorier les recettes d'images

L'list-image-recipesexemple suivant répertorie toutes vos recettes d'images.


aws imagebuilder list-image-recipes

Sortie :


{
    "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"
            }
        }
    ]
}

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, voir ListImageRecipesla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-images.

AWS CLI

Pour répertorier des images

L'list-imagesexemple suivant répertorie toutes les versions sémantiques auxquelles vous avez accès.


aws imagebuilder list-images

Sortie :


{
    "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"
        }
    ]
}

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, voir ListImagesla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-infrastructure-configurations.

AWS CLI

Pour répertorier les configurations d'infrastructure

L'list-infrastructure-configurationsexemple suivant répertorie toutes les configurations de votre infrastructure.


aws imagebuilder list-infrastructure-configurations

Sortie :


{
    "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"
            }
        }
    ]
}

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, voir ListInfrastructureConfigurationsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-tags-for-resource.

AWS CLI

Pour répertorier les balises d'une ressource spécifique

L'list-tags-for-resourceexemple suivant répertorie toutes les balises d'une ressource spécifique.


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

Sortie :


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

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, voir ListTagsForResourcela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserput-component-policy.

AWS CLI

Pour appliquer une politique de ressources à un composant

La put-component-policy commande suivante applique une politique de ressources à un composant de build afin de permettre le partage entre comptes des composants de build. Nous vous recommandons d'utiliser la commande RAM CLIcreate-resource-share. Si vous utilisez la commande EC2 Image Builder CLIput-component-policy, vous devez également utiliser la commande promote-resource-share-create-from-policy RAM CLI pour que la ressource soit visible par tous les principaux avec lesquels la ressource est partagée.


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" ] } ] }'

Sortie :


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

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, voir PutComponentPolicyla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserput-image-policy.

AWS CLI

Pour appliquer une politique de ressources à une image

La put-image-policy commande suivante applique une politique de ressources à une image afin de permettre le partage d'images entre comptes. Nous vous recommandons d'utiliser la commande RAM CLI create-resource-share. Si vous utilisez la commande EC2 Image Builder CLI put-image-policy, vous devez également utiliser la commande RAM CLI promote-resource-share-create -from-policy afin que la ressource soit visible par tous les principaux avec lesquels la ressource est partagée.


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" ] } ] }'

Sortie :


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

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, voir PutImagePolicyla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserput-image-recipe-policy.

AWS CLI

Pour appliquer une politique de ressources à une recette d'image

La put-image-recipe-policy commande suivante applique une politique de ressources à une recette d'image afin de permettre le partage de recettes d'images entre comptes. Nous vous recommandons d'utiliser la commande RAM CLIcreate-resource-share. Si vous utilisez la commande EC2 Image Builder CLIput-image-recipe-policy, vous devez également utiliser la commande promote-resource-share-create-from-policy RAM CLI pour que la ressource soit visible par tous les principaux avec lesquels la ressource est partagée.


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" ] } ] }'

Sortie :


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

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, voir PutImageRecipePolicyla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserstart-image-pipeline-execution.

AWS CLI

Pour démarrer un pipeline d'images manuellement

L'start-image-pipeline-executionexemple suivant démarre manuellement un pipeline d'images.


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

Sortie :


{
    "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"
}

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, voir StartImagePipelineExecutionla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisertag-resource.

AWS CLI

Pour étiqueter une ressource

L'tag-resourceexemple suivant ajoute et balise une ressource dans EC2 Image Builder à l'aide d'un fichier JSON.


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

Contenu de tag-resource.json :


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

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, voir TagResourcela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliseruntag-resource.

AWS CLI

Pour supprimer un tag d'une ressource

L'untag-resourceexemple suivant supprime une balise d'une ressource à l'aide d'un fichier JSON.


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

Contenu de untag-resource.json :


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

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, voir UntagResourcela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-distribution-configuration.

AWS CLI

Pour mettre à jour une configuration de distribution

L'update-distribution-configurationexemple suivant met à jour une configuration de distribution à l'aide d'un fichier JSON.


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

Contenu de 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}}"
            }
        }
    ]
}

Sortie :


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

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, voir UpdateDistributionConfigurationla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-image-pipeline.

AWS CLI

Pour mettre à jour un pipeline d'images

L'update-image-pipelineexemple suivant met à jour un pipeline d'images à l'aide d'un fichier JSON.


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

Contenu de 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"
}

Sortie :


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

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, voir UpdateImagePipelinela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-infrastructure-configuration.

AWS CLI

Pour mettre à jour la configuration d'une infrastructure

L'update-infrastructure-configurationexemple suivant met à jour une configuration d'infrastructure à l'aide d'un fichier JSON.


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

Contenu de 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"
}

Sortie :


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

Pour plus d'informations, consultez la section Configuration et gestion d'un pipeline d' EC2 images Image Builder à l'aide de la AWS CLI dans le guide de l'utilisateur EC2 d'Image Builder.

Pour plus de détails sur l'API, voir UpdateInfrastructureConfigurationla section Référence des AWS CLI commandes.

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

IAM Access Analyzer

Incident Manager