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	aws.imagebuilder.image_pipelines

Fields

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.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all image_pipelines in a region.

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 aws.imagebuilder.image_pipelines
WHERE region = 'us-east-1';

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 aws.imagebuilder.image_pipelines
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

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 aws.imagebuilder.image_pipelines (
 Name,
 Description,
 ImageTestsConfiguration,
 Status,
 Schedule,
 ImageRecipeArn,
 ContainerRecipeArn,
 DistributionConfigurationArn,
 InfrastructureConfigurationArn,
 Workflows,
 EnhancedImageMetadataEnabled,
 ImageScanningConfiguration,
 ExecutionRole,
 Tags,
 region
)
SELECT 
'{{ Name }}',
 '{{ Description }}',
 '{{ ImageTestsConfiguration }}',
 '{{ Status }}',
 '{{ Schedule }}',
 '{{ ImageRecipeArn }}',
 '{{ ContainerRecipeArn }}',
 '{{ DistributionConfigurationArn }}',
 '{{ InfrastructureConfigurationArn }}',
 '{{ Workflows }}',
 '{{ EnhancedImageMetadataEnabled }}',
 '{{ ImageScanningConfiguration }}',
 '{{ ExecutionRole }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.imagebuilder.image_pipelines (
 Name,
 Description,
 ImageTestsConfiguration,
 Status,
 Schedule,
 ImageRecipeArn,
 ContainerRecipeArn,
 DistributionConfigurationArn,
 InfrastructureConfigurationArn,
 Workflows,
 EnhancedImageMetadataEnabled,
 ImageScanningConfiguration,
 ExecutionRole,
 Tags,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Description }}',
 '{{ ImageTestsConfiguration }}',
 '{{ Status }}',
 '{{ Schedule }}',
 '{{ ImageRecipeArn }}',
 '{{ ContainerRecipeArn }}',
 '{{ DistributionConfigurationArn }}',
 '{{ InfrastructureConfigurationArn }}',
 '{{ Workflows }}',
 '{{ EnhancedImageMetadataEnabled }}',
 '{{ ImageScanningConfiguration }}',
 '{{ ExecutionRole }}',
 '{{ 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: ImageTestsConfiguration
        value:
          ImageTestsEnabled: '{{ ImageTestsEnabled }}'
          TimeoutMinutes: '{{ TimeoutMinutes }}'
      - name: Status
        value: '{{ Status }}'
      - name: Schedule
        value:
          ScheduleExpression: '{{ ScheduleExpression }}'
          PipelineExecutionStartCondition: '{{ PipelineExecutionStartCondition }}'
      - name: ImageRecipeArn
        value: '{{ ImageRecipeArn }}'
      - name: ContainerRecipeArn
        value: '{{ ContainerRecipeArn }}'
      - name: DistributionConfigurationArn
        value: '{{ DistributionConfigurationArn }}'
      - name: InfrastructureConfigurationArn
        value: '{{ InfrastructureConfigurationArn }}'
      - name: Workflows
        value:
          - WorkflowArn: '{{ WorkflowArn }}'
            Parameters:
              - Name: '{{ Name }}'
                Value:
                  - '{{ Value[0] }}'
            ParallelGroup: '{{ ParallelGroup }}'
            OnFailure: '{{ OnFailure }}'
      - name: EnhancedImageMetadataEnabled
        value: '{{ EnhancedImageMetadataEnabled }}'
      - name: ImageScanningConfiguration
        value:
          EcrConfiguration:
            ContainerTags:
              - '{{ ContainerTags[0] }}'
            RepositoryName: '{{ RepositoryName }}'
          ImageScanningEnabled: '{{ ImageScanningEnabled }}'
      - name: ExecutionRole
        value: '{{ ExecutionRole }}'
      - name: Tags
        value: {}

DELETE example

/*+ delete */
DELETE FROM aws.imagebuilder.image_pipelines
WHERE data__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

Read

imagebuilder:GetImagePipeline

Delete

imagebuilder:UnTagResource,
imagebuilder:GetImagePipeline,
imagebuilder:DeleteImagePipeline

List

imagebuilder:ListImagePipelines