interface ImagePipelineExecutionSettingsProperty

Language	Type name
.NET	Amazon.CDK.AWS.ImageBuilder.CfnImage.ImagePipelineExecutionSettingsProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsimagebuilder#CfnImage_ImagePipelineExecutionSettingsProperty
Java	software.amazon.awscdk.services.imagebuilder.CfnImage.ImagePipelineExecutionSettingsProperty
Python	aws_cdk.aws_imagebuilder.CfnImage.ImagePipelineExecutionSettingsProperty
TypeScript	aws-cdk-lib » aws_imagebuilder » CfnImage » ImagePipelineExecutionSettingsProperty

The settings for starting an image pipeline execution.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-imagepipelineexecutionsettings.html

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 imagePipelineExecutionSettingsProperty: imagebuilder.CfnImage.ImagePipelineExecutionSettingsProperty = {
  deploymentId: 'deploymentId',
  onUpdate: false,
};

Properties

Name	Type	Description
deploymentId?	string	The deployment ID of the pipeline, used to trigger new image pipeline executions.
onUpdate?	boolean | IResolvable	Whether to trigger the image pipeline when the pipeline is updated.

---

deploymentId?

Type: string (optional)

The deployment ID of the pipeline, used to trigger new image pipeline executions.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-imagepipelineexecutionsettings.html#cfn-imagebuilder-image-imagepipelineexecutionsettings-deploymentid

---

onUpdate?

Type: boolean | IResolvable (optional)

Whether to trigger the image pipeline when the pipeline is updated.

False by default.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-imagepipelineexecutionsettings.html#cfn-imagebuilder-image-imagepipelineexecutionsettings-onupdate