Interface ICfnImagePipelineProps
Properties for defining a CfnImagePipeline
.
Namespace: Amazon.CDK.AWS.ImageBuilder
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnImagePipelineProps
Syntax (vb)
Public Interface ICfnImagePipelineProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ImageBuilder;
var cfnImagePipelineProps = new CfnImagePipelineProps {
InfrastructureConfigurationArn = "infrastructureConfigurationArn",
Name = "name",
// the properties below are optional
ContainerRecipeArn = "containerRecipeArn",
Description = "description",
DistributionConfigurationArn = "distributionConfigurationArn",
EnhancedImageMetadataEnabled = false,
ExecutionRole = "executionRole",
ImageRecipeArn = "imageRecipeArn",
ImageScanningConfiguration = new ImageScanningConfigurationProperty {
EcrConfiguration = new EcrConfigurationProperty {
ContainerTags = new [] { "containerTags" },
RepositoryName = "repositoryName"
},
ImageScanningEnabled = false
},
ImageTestsConfiguration = new ImageTestsConfigurationProperty {
ImageTestsEnabled = false,
TimeoutMinutes = 123
},
Schedule = new ScheduleProperty {
PipelineExecutionStartCondition = "pipelineExecutionStartCondition",
ScheduleExpression = "scheduleExpression"
},
Status = "status",
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
},
Workflows = new [] { new WorkflowConfigurationProperty {
OnFailure = "onFailure",
ParallelGroup = "parallelGroup",
Parameters = new [] { new WorkflowParameterProperty {
Name = "name",
Value = new [] { "value" }
} },
WorkflowArn = "workflowArn"
} }
};
Synopsis
Properties
ContainerRecipeArn | The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline. |
Description | The description of this image pipeline. |
DistributionConfigurationArn | The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline. |
EnhancedImageMetadataEnabled | Collects additional information about the image being created, including the operating system (OS) version and package list. |
ExecutionRole | The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions. |
ImageRecipeArn | The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline. |
ImageScanningConfiguration | Contains settings for vulnerability scans. |
ImageTestsConfiguration | The configuration of the image tests that run after image creation to ensure the quality of the image that was created. |
InfrastructureConfigurationArn | The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline. |
Name | The name of the image pipeline. |
Schedule | The schedule of the image pipeline. |
Status | The status of the image pipeline. |
Tags | The tags of this image pipeline. |
Workflows | Contains the workflows that run for the image pipeline. |
Properties
ContainerRecipeArn
The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
virtual string ContainerRecipeArn { get; }
Property Value
System.String
Remarks
Description
The description of this image pipeline.
virtual string Description { get; }
Property Value
System.String
Remarks
DistributionConfigurationArn
The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
virtual string DistributionConfigurationArn { get; }
Property Value
System.String
Remarks
EnhancedImageMetadataEnabled
Collects additional information about the image being created, including the operating system (OS) version and package list.
virtual object EnhancedImageMetadataEnabled { get; }
Property Value
System.Object
Remarks
This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
ExecutionRole
The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
virtual string ExecutionRole { get; }
Property Value
System.String
Remarks
ImageRecipeArn
The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.
virtual string ImageRecipeArn { get; }
Property Value
System.String
Remarks
ImageScanningConfiguration
Contains settings for vulnerability scans.
virtual object ImageScanningConfiguration { get; }
Property Value
System.Object
Remarks
ImageTestsConfiguration
The configuration of the image tests that run after image creation to ensure the quality of the image that was created.
virtual object ImageTestsConfiguration { get; }
Property Value
System.Object
Remarks
InfrastructureConfigurationArn
The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
string InfrastructureConfigurationArn { get; }
Property Value
System.String
Remarks
Name
The name of the image pipeline.
string Name { get; }
Property Value
System.String
Remarks
Schedule
The schedule of the image pipeline.
virtual object Schedule { get; }
Property Value
System.Object
Remarks
A schedule configures how often and when a pipeline automatically creates a new image.
Status
The status of the image pipeline.
virtual string Status { get; }
Property Value
System.String
Remarks
Tags
The tags of this image pipeline.
virtual IDictionary<string, string> Tags { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
Workflows
Contains the workflows that run for the image pipeline.
virtual object Workflows { get; }
Property Value
System.Object