imagebuilder/aws.sdk.kotlin.services.imagebuilder/updateImagePipeline

updateImagePipeline

inline suspend fun ImagebuilderClient.updateImagePipeline(crossinline block: UpdateImagePipelineRequest.Builder.() -> Unit): UpdateImagePipelineResponse

Updates an image pipeline. Use image pipelines to automate the creation and distribution of images. You must specify exactly one recipe for your image, using either a containerRecipeArn or an imageRecipeArn. The recipe must be the same type, image or container, as the pipeline's current recipe.

UpdateImagePipeline does not support selective updates. The request replaces the pipeline's entire configuration, so include every setting that you want to keep. Any optional property that you omit is removed or reset to its default.

Samples

// The following example changes the pipeline s schedule to build every day at 6 00 AM UTC.
val resp = imagebuilderClient.updateImagePipeline {
    imagePipelineArn = "arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline"
    imageRecipeArn = "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.0.0"
    infrastructureConfigurationArn = "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure"
    schedule = Schedule {
        scheduleExpression = "cron(0 6 * * ? *)"
        pipelineExecutionStartCondition = PipelineExecutionStartCondition.fromValue("EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE")
    }
    status = PipelineStatus.fromValue("ENABLED")
    clientToken = "a1b2c3d4-5678-90ab-cdef-EXAMPLEddddd"
}