Class CfnImagePipeline
A CloudFormation AWS::ImageBuilder::ImagePipeline
.
Inherited Members
Namespace: Amazon.CDK.AWS.ImageBuilder
Assembly: Amazon.CDK.AWS.ImageBuilder.dll
Syntax (csharp)
public class CfnImagePipeline : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnImagePipeline
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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.
CloudformationResource: AWS::ImageBuilder::ImagePipeline
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 cfnImagePipeline = new CfnImagePipeline(this, "MyCfnImagePipeline", new CfnImagePipelineProps {
InfrastructureConfigurationArn = "infrastructureConfigurationArn",
Name = "name",
// the properties below are optional
ContainerRecipeArn = "containerRecipeArn",
Description = "description",
DistributionConfigurationArn = "distributionConfigurationArn",
EnhancedImageMetadataEnabled = false,
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" }
}
});
Synopsis
Constructors
CfnImagePipeline(Construct, String, ICfnImagePipelineProps) | Create a new |
CfnImagePipeline(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnImagePipeline(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | Returns the Amazon Resource Name (ARN) of the image pipeline. |
AttrName | Returns the name of the image pipeline. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
ImageRecipeArn | The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline. |
ImageScanningConfiguration |
|
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnImagePipeline(Construct, String, ICfnImagePipelineProps)
Create a new AWS::ImageBuilder::ImagePipeline
.
public CfnImagePipeline(Construct scope, string id, ICfnImagePipelineProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnImagePipelineProps
- resource properties.
CfnImagePipeline(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnImagePipeline(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnImagePipeline(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnImagePipeline(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
Returns the Amazon Resource Name (ARN) of the image pipeline.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
For example, arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline
.
CloudformationAttribute: Arn
AttrName
Returns the name of the image pipeline.
public virtual string AttrName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Name
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ContainerRecipeArn
The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
public virtual string ContainerRecipeArn { get; set; }
Property Value
System.String
Remarks
Description
The description of this image pipeline.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
DistributionConfigurationArn
The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
public virtual string DistributionConfigurationArn { get; set; }
Property Value
System.String
Remarks
EnhancedImageMetadataEnabled
Collects additional information about the image being created, including the operating system (OS) version and package list.
public virtual object EnhancedImageMetadataEnabled { get; set; }
Property Value
System.Object
Remarks
This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
ImageRecipeArn
The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.
public virtual string ImageRecipeArn { get; set; }
Property Value
System.String
Remarks
ImageScanningConfiguration
AWS::ImageBuilder::ImagePipeline.ImageScanningConfiguration
.
public virtual object ImageScanningConfiguration { get; set; }
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.
public virtual object ImageTestsConfiguration { get; set; }
Property Value
System.Object
Remarks
InfrastructureConfigurationArn
The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
public virtual string InfrastructureConfigurationArn { get; set; }
Property Value
System.String
Remarks
Name
The name of the image pipeline.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
Schedule
The schedule of the image pipeline.
public virtual object Schedule { get; set; }
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.
public virtual string Status { get; set; }
Property Value
System.String
Remarks
Tags
The tags of this image pipeline.
public virtual TagManager Tags { get; }
Property Value
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>