aws-cdk-lib.aws_imagebuilder.CfnImagePipeline

class CfnImagePipeline (construct)

LanguageType name
.NETAmazon.CDK.AWS.ImageBuilder.CfnImagePipeline
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsimagebuilder#CfnImagePipeline
Javasoftware.amazon.awscdk.services.imagebuilder.CfnImagePipeline
Pythonaws_cdk.aws_imagebuilder.CfnImagePipeline
TypeScript aws-cdk-lib » aws_imagebuilder » CfnImagePipeline

Implements IConstruct, IDependable, IInspectable

A CloudFormation AWS::ImageBuilder::ImagePipeline.

An image pipeline is the automation configuration for building secure OS images on AWS . The Image Builder image pipeline is associated with an image recipe that defines the build, validation, and test phases for an image build lifecycle. An image pipeline can be associated with an infrastructure configuration that defines where your image is built. You can define attributes, such as instance type, subnets, security groups, logging, and other infrastructure-related configurations. You can also associate your image pipeline with a distribution configuration to define how you would like to deploy your image.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_imagebuilder as imagebuilder } from 'aws-cdk-lib';
const cfnImagePipeline = new imagebuilder.CfnImagePipeline(this, 'MyCfnImagePipeline', {
  infrastructureConfigurationArn: 'infrastructureConfigurationArn',
  name: 'name',

  // the properties below are optional
  containerRecipeArn: 'containerRecipeArn',
  description: 'description',
  distributionConfigurationArn: 'distributionConfigurationArn',
  enhancedImageMetadataEnabled: false,
  imageRecipeArn: 'imageRecipeArn',
  imageScanningConfiguration: {
    ecrConfiguration: {
      containerTags: ['containerTags'],
      repositoryName: 'repositoryName',
    },
    imageScanningEnabled: false,
  },
  imageTestsConfiguration: {
    imageTestsEnabled: false,
    timeoutMinutes: 123,
  },
  schedule: {
    pipelineExecutionStartCondition: 'pipelineExecutionStartCondition',
    scheduleExpression: 'scheduleExpression',
  },
  status: 'status',
  tags: {
    tagsKey: 'tags',
  },
});

Initializer

new CfnImagePipeline(scope: Construct, id: string, props: CfnImagePipelineProps)

Parameters

  • scope Construct — - scope in which this resource is defined.
  • id string — - scoped id of the resource.
  • props CfnImagePipelineProps — - resource properties.

Create a new AWS::ImageBuilder::ImagePipeline.

Construct Props

NameTypeDescription
infrastructureConfigurationArnstringThe Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
namestringThe name of the image pipeline.
containerRecipeArn?stringThe Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
description?stringThe description of this image pipeline.
distributionConfigurationArn?stringThe Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
enhancedImageMetadataEnabled?boolean | IResolvableCollects additional information about the image being created, including the operating system (OS) version and package list.
imageRecipeArn?stringThe Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.
imageScanningConfiguration?IResolvable | ImageScanningConfigurationPropertyAWS::ImageBuilder::ImagePipeline.ImageScanningConfiguration.
imageTestsConfiguration?IResolvable | ImageTestsConfigurationPropertyThe configuration of the image tests that run after image creation to ensure the quality of the image that was created.
schedule?IResolvable | SchedulePropertyThe schedule of the image pipeline.
status?stringThe status of the image pipeline.
tags?{ [string]: string }The tags of this image pipeline.

infrastructureConfigurationArn

Type: string

The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.


name

Type: string

The name of the image pipeline.


containerRecipeArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.


description?

Type: string (optional)

The description of this image pipeline.


distributionConfigurationArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.


enhancedImageMetadataEnabled?

Type: boolean | IResolvable (optional)

Collects additional information about the image being created, including the operating system (OS) version and package list.

This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.


imageRecipeArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.


imageScanningConfiguration?

Type: IResolvable | ImageScanningConfigurationProperty (optional)

AWS::ImageBuilder::ImagePipeline.ImageScanningConfiguration.


imageTestsConfiguration?

Type: IResolvable | ImageTestsConfigurationProperty (optional)

The configuration of the image tests that run after image creation to ensure the quality of the image that was created.


schedule?

Type: IResolvable | ScheduleProperty (optional)

The schedule of the image pipeline.

A schedule configures how often and when a pipeline automatically creates a new image.


status?

Type: string (optional)

The status of the image pipeline.


tags?

Type: { [string]: string } (optional)

The tags of this image pipeline.

Properties

NameTypeDescription
attrArnstringReturns the Amazon Resource Name (ARN) of the image pipeline.
attrNamestringReturns the name of the image pipeline.
cfnOptionsICfnResourceOptionsOptions for this resource, such as condition, update policy etc.
cfnProperties{ [string]: any }
cfnResourceTypestringAWS resource type.
creationStackstring[]
infrastructureConfigurationArnstringThe Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
logicalIdstringThe logical ID for this CloudFormation stack element.
namestringThe name of the image pipeline.
nodeNodeThe tree node.
refstringReturn a string that will be resolved to a CloudFormation { Ref } for this element.
stackStackThe stack in which this element is defined.
tagsTagManagerThe tags of this image pipeline.
containerRecipeArn?stringThe Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
description?stringThe description of this image pipeline.
distributionConfigurationArn?stringThe Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
enhancedImageMetadataEnabled?boolean | IResolvableCollects additional information about the image being created, including the operating system (OS) version and package list.
imageRecipeArn?stringThe Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.
imageScanningConfiguration?IResolvable | ImageScanningConfigurationPropertyAWS::ImageBuilder::ImagePipeline.ImageScanningConfiguration.
imageTestsConfiguration?IResolvable | ImageTestsConfigurationPropertyThe configuration of the image tests that run after image creation to ensure the quality of the image that was created.
schedule?IResolvable | SchedulePropertyThe schedule of the image pipeline.
status?stringThe status of the image pipeline.
static CFN_RESOURCE_TYPE_NAMEstringThe CloudFormation resource type name for this resource class.

attrArn

Type: string

Returns the Amazon Resource Name (ARN) of the image pipeline.

For example, arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline .


attrName

Type: string

Returns the name of the image pipeline.


cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.


cfnProperties

Type: { [string]: any }


cfnResourceType

Type: string

AWS resource type.


creationStack

Type: string[]


infrastructureConfigurationArn

Type: string

The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.


logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).


name

Type: string

The name of the image pipeline.


node

Type: Node

The tree node.


ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).


stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).


tags

Type: TagManager

The tags of this image pipeline.


containerRecipeArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.


description?

Type: string (optional)

The description of this image pipeline.


distributionConfigurationArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.


enhancedImageMetadataEnabled?

Type: boolean | IResolvable (optional)

Collects additional information about the image being created, including the operating system (OS) version and package list.

This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.


imageRecipeArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.


imageScanningConfiguration?

Type: IResolvable | ImageScanningConfigurationProperty (optional)

AWS::ImageBuilder::ImagePipeline.ImageScanningConfiguration.


imageTestsConfiguration?

Type: IResolvable | ImageTestsConfigurationProperty (optional)

The configuration of the image tests that run after image creation to ensure the quality of the image that was created.


schedule?

Type: IResolvable | ScheduleProperty (optional)

The schedule of the image pipeline.

A schedule configures how often and when a pipeline automatically creates a new image.


status?

Type: string (optional)

The status of the image pipeline.


static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

NameDescription
addDeletionOverride(path)Syntactic sugar for addOverride(path, undefined).
addDependency(target)Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)Returns a token for an runtime attribute of this resource.
getMetadata(key)Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)Examines the CloudFormation resource and discloses attributes.
obtainDependencies()Retrieves an array of resources this resource depends on.
obtainResourceDependencies()Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)Replaces one dependency with another.
toString()Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

  • path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).


addDependency(target)

public addDependency(target: CfnResource): void

Parameters

  • target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.


addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

  • target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.


addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

  • key string
  • value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)


addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

  • path string — - The path of the property, you can use dot notation to override values in complex types.
  • value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.


addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

  • propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.


addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

  • propertyPath string — The path of the property.
  • value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).


applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

  • policy RemovalPolicy
  • options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options


getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

  • attributeName string — The name of the attribute.
  • typeHint ResolutionTypeHint

Returns

  • Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.


getMetadata(key)

public getMetadata(key: string): any

Parameters

  • key string

Returns

  • any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)


inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

  • inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.


obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

  • Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.


obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

  • CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.


overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

  • newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.


removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

  • target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.


replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

  • target CfnResource — The dependency to replace.
  • newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.


toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.


protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

  • props { [string]: any }

Returns

  • { [string]: any }