Interface CfnImagePipelineProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnImagePipelineProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
date="2025-10-24T13:34:39.941Z")
@Stability(Stable)
public interface CfnImagePipelineProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnImagePipeline.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.imagebuilder.*;
CfnImagePipelineProps cfnImagePipelineProps = CfnImagePipelineProps.builder()
.infrastructureConfigurationArn("infrastructureConfigurationArn")
.name("name")
// the properties below are optional
.containerRecipeArn("containerRecipeArn")
.description("description")
.distributionConfigurationArn("distributionConfigurationArn")
.enhancedImageMetadataEnabled(false)
.executionRole("executionRole")
.imageRecipeArn("imageRecipeArn")
.imageScanningConfiguration(ImageScanningConfigurationProperty.builder()
.ecrConfiguration(EcrConfigurationProperty.builder()
.containerTags(List.of("containerTags"))
.repositoryName("repositoryName")
.build())
.imageScanningEnabled(false)
.build())
.imageTestsConfiguration(ImageTestsConfigurationProperty.builder()
.imageTestsEnabled(false)
.timeoutMinutes(123)
.build())
.loggingConfiguration(PipelineLoggingConfigurationProperty.builder()
.imageLogGroupName("imageLogGroupName")
.pipelineLogGroupName("pipelineLogGroupName")
.build())
.schedule(ScheduleProperty.builder()
.autoDisablePolicy(AutoDisablePolicyProperty.builder()
.failureCount(123)
.build())
.pipelineExecutionStartCondition("pipelineExecutionStartCondition")
.scheduleExpression("scheduleExpression")
.build())
.status("status")
.tags(Map.of(
"tagsKey", "tags"))
.workflows(List.of(WorkflowConfigurationProperty.builder()
.onFailure("onFailure")
.parallelGroup("parallelGroup")
.parameters(List.of(WorkflowParameterProperty.builder()
.name("name")
.value(List.of("value"))
.build()))
.workflowArn("workflowArn")
.build()))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnImagePipelinePropsstatic final classAn implementation forCfnImagePipelineProps -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default StringThe Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.default StringThe description of this image pipeline.default StringThe Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.default ObjectCollects additional information about the image being created, including the operating system (OS) version and package list.default StringThe name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.default StringThe Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.default ObjectContains settings for vulnerability scans.default ObjectThe configuration of the image tests that run after image creation to ensure the quality of the image that was created.The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.default ObjectDefines logging configuration for the output image.getName()The name of the image pipeline.default ObjectThe schedule of the image pipeline.default StringThe status of the image pipeline.getTags()The tags of this image pipeline.default ObjectContains the workflows that run for the image pipeline.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getInfrastructureConfigurationArn
The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.- See Also:
-
getName
The name of the image pipeline.- See Also:
-
getContainerRecipeArn
The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.- See Also:
-
getDescription
The description of this image pipeline.- See Also:
-
getDistributionConfigurationArn
The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.- See Also:
-
getEnhancedImageMetadataEnabled
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.
Returns union: either
BooleanorIResolvable- See Also:
-
getExecutionRole
The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.- See Also:
-
getImageRecipeArn
The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.- See Also:
-
getImageScanningConfiguration
Contains settings for vulnerability scans.Returns union: either
IResolvableorCfnImagePipeline.ImageScanningConfigurationProperty- See Also:
-
getImageTestsConfiguration
The configuration of the image tests that run after image creation to ensure the quality of the image that was created.Returns union: either
IResolvableorCfnImagePipeline.ImageTestsConfigurationProperty- See Also:
-
getLoggingConfiguration
Defines logging configuration for the output image.Returns union: either
IResolvableorCfnImagePipeline.PipelineLoggingConfigurationProperty- See Also:
-
getSchedule
The schedule of the image pipeline.A schedule configures how often and when a pipeline automatically creates a new image.
Returns union: either
IResolvableorCfnImagePipeline.ScheduleProperty- See Also:
-
getStatus
The status of the image pipeline.- See Also:
-
getTags
The tags of this image pipeline.- See Also:
-
getWorkflows
Contains the workflows that run for the image pipeline.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnImagePipeline.WorkflowConfigurationProperty>- See Also:
-
builder
- Returns:
- a
CfnImagePipelineProps.BuilderofCfnImagePipelineProps
-