image_pipelines

Creates, updates, deletes or gets an image_pipeline resource or lists image_pipelines in a region

Overview

Name	image_pipelines
Type	Resource
Description	Resource schema for AWS::ImageBuilder::ImagePipeline
Id	awscc.imagebuilder.image_pipelines

Fields

get (all properties)

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the image pipeline.
name	string	The name of the image pipeline.
description	string	The description of the image pipeline.
▶image_tests_configuration	object	The image tests configuration of the image pipeline.
status	string	The status of the image pipeline.
▶schedule	object	The schedule of the image pipeline.
image_recipe_arn	string	The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
container_recipe_arn	string	The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
distribution_configuration_arn	string	The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
infrastructure_configuration_arn	string	The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
▶workflows	array	Workflows to define the image build process
enhanced_image_metadata_enabled	boolean	Collects additional information about the image being created, including the operating system (OS) version and package list.
▶image_scanning_configuration	object	Contains settings for vulnerability scans.
execution_role	string	The execution role name/ARN for the image build, if provided
tags	object	The tags of this image pipeline.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the image pipeline.
region	string	AWS region.

For more information, see AWS::ImageBuilder::ImagePipeline.

Methods

Name	Resource	Accessible by	Required Params
create_resource	image_pipelines	INSERT	region
delete_resource	image_pipelines	DELETE	Identifier, region
update_resource	image_pipelines	UPDATE	Identifier, PatchDocument, region
list_resources	image_pipelines_list_only	SELECT	region
get_resource	image_pipelines	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual image_pipeline.

SELECT
  region,
  arn,
  name,
  description,
  image_tests_configuration,
  status,
  schedule,
  image_recipe_arn,
  container_recipe_arn,
  distribution_configuration_arn,
  infrastructure_configuration_arn,
  workflows,
  enhanced_image_metadata_enabled,
  image_scanning_configuration,
  execution_role,
  tags
FROM awscc.imagebuilder.image_pipelines
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all image_pipelines in a region.

SELECT
  region,
  arn
FROM awscc.imagebuilder.image_pipelines_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new image_pipeline resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.imagebuilder.image_pipelines (
  Name,
  Description,
  ImageTestsConfiguration,
  Status,
  Schedule,
  ImageRecipeArn,
  ContainerRecipeArn,
  DistributionConfigurationArn,
  InfrastructureConfigurationArn,
  Workflows,
  EnhancedImageMetadataEnabled,
  ImageScanningConfiguration,
  ExecutionRole,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ description }}',
  '{{ image_tests_configuration }}',
  '{{ status }}',
  '{{ schedule }}',
  '{{ image_recipe_arn }}',
  '{{ container_recipe_arn }}',
  '{{ distribution_configuration_arn }}',
  '{{ infrastructure_configuration_arn }}',
  '{{ workflows }}',
  '{{ enhanced_image_metadata_enabled }}',
  '{{ image_scanning_configuration }}',
  '{{ execution_role }}',
  '{{ tags }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.imagebuilder.image_pipelines (
  Name,
  Description,
  ImageTestsConfiguration,
  Status,
  Schedule,
  ImageRecipeArn,
  ContainerRecipeArn,
  DistributionConfigurationArn,
  InfrastructureConfigurationArn,
  Workflows,
  EnhancedImageMetadataEnabled,
  ImageScanningConfiguration,
  ExecutionRole,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ description }}',
  '{{ image_tests_configuration }}',
  '{{ status }}',
  '{{ schedule }}',
  '{{ image_recipe_arn }}',
  '{{ container_recipe_arn }}',
  '{{ distribution_configuration_arn }}',
  '{{ infrastructure_configuration_arn }}',
  '{{ workflows }}',
  '{{ enhanced_image_metadata_enabled }}',
  '{{ image_scanning_configuration }}',
  '{{ execution_role }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: image_pipeline
    props:
      - name: name
        value: '{{ name }}'
      - name: description
        value: '{{ description }}'
      - name: image_tests_configuration
        value:
          image_tests_enabled: '{{ image_tests_enabled }}'
          timeout_minutes: '{{ timeout_minutes }}'
      - name: status
        value: '{{ status }}'
      - name: schedule
        value:
          schedule_expression: '{{ schedule_expression }}'
          pipeline_execution_start_condition: '{{ pipeline_execution_start_condition }}'
      - name: image_recipe_arn
        value: '{{ image_recipe_arn }}'
      - name: container_recipe_arn
        value: '{{ container_recipe_arn }}'
      - name: distribution_configuration_arn
        value: '{{ distribution_configuration_arn }}'
      - name: infrastructure_configuration_arn
        value: '{{ infrastructure_configuration_arn }}'
      - name: workflows
        value:
          - workflow_arn: '{{ workflow_arn }}'
            parameters:
              - name: '{{ name }}'
                value:
                  - '{{ value[0] }}'
            parallel_group: '{{ parallel_group }}'
            on_failure: '{{ on_failure }}'
      - name: enhanced_image_metadata_enabled
        value: '{{ enhanced_image_metadata_enabled }}'
      - name: image_scanning_configuration
        value:
          ecr_configuration:
            container_tags:
              - '{{ container_tags[0] }}'
            repository_name: '{{ repository_name }}'
          image_scanning_enabled: '{{ image_scanning_enabled }}'
      - name: execution_role
        value: '{{ execution_role }}'
      - name: tags
        value: {}

UPDATE example

Use the following StackQL query and manifest file to update a image_pipeline resource, using stack-deploy.

/*+ update */
UPDATE awscc.imagebuilder.image_pipelines
SET PatchDocument = string('{{ {
    "Description": description,
    "ImageTestsConfiguration": image_tests_configuration,
    "Status": status,
    "Schedule": schedule,
    "ImageRecipeArn": image_recipe_arn,
    "ContainerRecipeArn": container_recipe_arn,
    "DistributionConfigurationArn": distribution_configuration_arn,
    "InfrastructureConfigurationArn": infrastructure_configuration_arn,
    "Workflows": workflows,
    "EnhancedImageMetadataEnabled": enhanced_image_metadata_enabled,
    "ImageScanningConfiguration": image_scanning_configuration,
    "ExecutionRole": execution_role,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.imagebuilder.image_pipelines
WHERE
  Identifier = '{{ arn }}' AND
  region = 'us-east-1';

Permissions

To operate on the image_pipelines resource, the following permissions are required:

Create

ecr:BatchGetRepositoryScanningConfiguration,
iam:GetRole,
iam:PassRole,
iam:CreateServiceLinkedRole,
imagebuilder:TagResource,
imagebuilder:GetImagePipeline,
imagebuilder:GetImageRecipe,
imagebuilder:GetInfrastructureConfiguration,
imagebuilder:GetDistributionConfiguration,
imagebuilder:CreateImagePipeline,
imagebuilder:GetWorkflow,
inspector2:BatchGetAccountStatus

Update

iam:PassRole,
imagebuilder:GetImagePipeline,
imagebuilder:UpdateImagePipeline,
imagebuilder:GetWorkflow,
imagebuilder:TagResource,
imagebuilder:UntagResource

Read

imagebuilder:GetImagePipeline

Delete

imagebuilder:UntagResource,
imagebuilder:GetImagePipeline,
imagebuilder:DeleteImagePipeline

List

imagebuilder:ListImagePipelines