Skip to content

Creates a new image pipeline

Description

Creates a new image pipeline. Use image pipelines to automate the creation and distribution of images. You must specify exactly one recipe for the pipeline, using either a containerRecipeArn or an imageRecipeArn.

Usage

imagebuilder_create_image_pipeline(name, description, imageRecipeArn,
  containerRecipeArn, infrastructureConfigurationArn,
  distributionConfigurationArn, imageTestsConfiguration,
  enhancedImageMetadataEnabled, schedule, status, tags, imageTags,
  clientToken, imageScanningConfiguration, workflows, executionRole,
  loggingConfiguration, dryRun)

Arguments

  • name

    [required] The name of the image pipeline. Pipeline names must be unique to your account in each Amazon Web Services Region. Image Builder generates the pipeline ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name.

  • description

    The description of the image pipeline.

  • imageRecipeArn

    The Amazon Resource Name (ARN) of the image recipe that configures images created by this image pipeline. You must specify either this property or containerRecipeArn, but not both.

  • containerRecipeArn

    The Amazon Resource Name (ARN) of the container recipe that is used to configure images created by this container pipeline. You must specify either this property or imageRecipeArn, but not both.

  • infrastructureConfigurationArn

    [required] The Amazon Resource Name (ARN) of the infrastructure configuration that builds images created by this image pipeline.

  • distributionConfigurationArn

    The Amazon Resource Name (ARN) of the distribution configuration that configures and distributes images created by this image pipeline.

  • imageTestsConfiguration

    Specifies the test settings that Image Builder applies to images that this pipeline creates. If you don't provide test settings, Image Builder stores a default configuration with image tests enabled.

  • enhancedImageMetadataEnabled

    Specifies whether to collect additional information about the image being created, including the operating system (OS) version and package list. Defaults to true.

  • schedule

    The schedule of the image pipeline. If you don't provide a schedule, the pipeline runs only when you call start_image_pipeline_execution.

  • status

    The status of the image pipeline. If you don't specify a status, it defaults to ENABLED. A disabled pipeline doesn't run on its schedule, but you can still start builds manually.

  • tags

    The tags of the image pipeline.

  • imageTags

    The tags that Image Builder applies to the Image Builder image resource that this pipeline's scheduled executions create. These tags don't apply to the output AMI. To tag output AMIs, use amiTags in the pipeline's distribution configuration.

  • clientToken

    [required] A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

  • imageScanningConfiguration

    Contains settings for vulnerability scans that Amazon Inspector runs against the test instance during image creation.

  • workflows

    The array of workflow configuration objects for builds that this pipeline starts. You must also specify executionRole when you provide workflows.

  • executionRole

    The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

  • loggingConfiguration

    Specifies the logging configuration for the image pipeline. Use this to define custom CloudWatch Logs log groups for your pipeline execution logs and image build logs. The service manages log groups with names starting with /aws/imagebuilder/ using the service-linked role. For custom log group names outside of this prefix, you must also provide an executionRole.

  • dryRun

    Validates the required permissions and request parameters without performing the operation. If validation succeeds, the operation returns a DryRunOperationException error response.

Value

A list with the following syntax:

list(
  requestId = "string",
  clientToken = "string",
  imagePipelineArn = "string"
)

Request syntax

svc$create_image_pipeline(
  name = "string",
  description = "string",
  imageRecipeArn = "string",
  containerRecipeArn = "string",
  infrastructureConfigurationArn = "string",
  distributionConfigurationArn = "string",
  imageTestsConfiguration = list(
    imageTestsEnabled = TRUE|FALSE,
    timeoutMinutes = 123
  ),
  enhancedImageMetadataEnabled = TRUE|FALSE,
  schedule = list(
    scheduleExpression = "string",
    timezone = "string",
    pipelineExecutionStartCondition = "EXPRESSION_MATCH_ONLY"|"EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE",
    autoDisablePolicy = list(
      failureCount = 123
    )
  ),
  status = "DISABLED"|"ENABLED",
  tags = list(
    "string"
  ),
  imageTags = list(
    "string"
  ),
  clientToken = "string",
  imageScanningConfiguration = list(
    imageScanningEnabled = TRUE|FALSE,
    ecrConfiguration = list(
      repositoryName = "string",
      containerTags = list(
        "string"
      )
    )
  ),
  workflows = list(
    list(
      workflowArn = "string",
      parameters = list(
        list(
          name = "string",
          value = list(
            "string"
          )
        )
      ),
      parallelGroup = "string",
      onFailure = "CONTINUE"|"ABORT"
    )
  ),
  executionRole = "string",
  loggingConfiguration = list(
    imageLogGroupName = "string",
    pipelineLogGroupName = "string"
  ),
  dryRun = TRUE|FALSE
)