Class CfnImagePipelineProps

Properties for defining a CfnImagePipeline.

Inheritance

System.Object

CfnImagePipelineProps

Implements

ICfnImagePipelineProps

Namespace: Amazon.CDK.AWS.ImageBuilder

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnImagePipelineProps : Object, ICfnImagePipelineProps

Syntax (vb)

Public Class CfnImagePipelineProps
    Inherits Object
    Implements ICfnImagePipelineProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html

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

Constructors

CfnImagePipelineProps()

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.

Constructors

CfnImagePipelineProps()

public CfnImagePipelineProps()

Properties

ContainerRecipeArn

The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.

public string ContainerRecipeArn { get; set; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-containerrecipearn

Description

The description of this image pipeline.

public string Description { get; set; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-description

DistributionConfigurationArn

The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.

public string DistributionConfigurationArn { get; set; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-distributionconfigurationarn

EnhancedImageMetadataEnabled

Collects additional information about the image being created, including the operating system (OS) version and package list.

public 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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-enhancedimagemetadataenabled

ExecutionRole

The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

public string ExecutionRole { get; set; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-executionrole

ImageRecipeArn

The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.

public string ImageRecipeArn { get; set; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-imagerecipearn

ImageScanningConfiguration

Contains settings for vulnerability scans.

public object ImageScanningConfiguration { get; set; }

Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-imagescanningconfiguration

ImageTestsConfiguration

The configuration of the image tests that run after image creation to ensure the quality of the image that was created.

public object ImageTestsConfiguration { get; set; }

Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-imagetestsconfiguration

InfrastructureConfigurationArn

The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.

public string InfrastructureConfigurationArn { get; set; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-infrastructureconfigurationarn

Name

The name of the image pipeline.

public string Name { get; set; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-name

Schedule

The schedule of the image pipeline.

public object Schedule { get; set; }

Property Value

System.Object

Remarks

A schedule configures how often and when a pipeline automatically creates a new image.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-schedule

Status

The status of the image pipeline.

public string Status { get; set; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-status

Workflows

Contains the workflows that run for the image pipeline.

public object Workflows { get; set; }

Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-imagepipeline.html#cfn-imagebuilder-imagepipeline-workflows

Implements

ICfnImagePipelineProps