Interface CfnImagePipelineProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnImagePipelineProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-12-17T21:37:32.328Z")
@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()) .schedule(ScheduleProperty.builder() .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
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnImagePipelineProps
static final class
An implementation forCfnImagePipelineProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.default String
The description of this image pipeline.default String
The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.default Object
Collects additional information about the image being created, including the operating system (OS) version and package list.default String
The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.default String
The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.default Object
Contains settings for vulnerability scans.default Object
The 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.getName()
The name of the image pipeline.default Object
The schedule of the image pipeline.default String
The status of the image pipeline.getTags()
The tags of this image pipeline.default Object
Contains 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.
- 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.- See Also:
-
getImageTestsConfiguration
The configuration of the image tests that run after image creation to ensure the quality of the image that was created.- See Also:
-
getSchedule
The schedule of the image pipeline.A schedule configures how often and when a pipeline automatically creates a new image.
- 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.- See Also:
-
builder
- Returns:
- a
CfnImagePipelineProps.Builder
ofCfnImagePipelineProps
-