Class CfnImageProps

Properties for defining a CfnImage.

Inheritance

System.Object

CfnImageProps

Implements

ICfnImageProps

Namespace: Amazon.CDK.AWS.ImageBuilder

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnImageProps : Object, ICfnImageProps

Syntax (vb)

Public Class CfnImageProps
    Inherits Object
    Implements ICfnImageProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.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 cfnImageProps = new CfnImageProps {
    ContainerRecipeArn = "containerRecipeArn",
    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
    },
    InfrastructureConfigurationArn = "infrastructureConfigurationArn",
    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

CfnImageProps()

Properties

ContainerRecipeArn	The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
DistributionConfigurationArn	The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your 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 that defines how images are configured, tested, and assessed.
ImageScanningConfiguration	Contains settings for vulnerability scans.
ImageTestsConfiguration	The image tests configuration of the image.
InfrastructureConfigurationArn	The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.
Tags	The tags of the image.
Workflows	Contains an array of workflow configuration objects.

Constructors

CfnImageProps()

public CfnImageProps()

Properties

ContainerRecipeArn

The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.

public string ContainerRecipeArn { get; set; }

Property Value

System.String

Remarks

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

DistributionConfigurationArn

The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.

public string DistributionConfigurationArn { get; set; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-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-image.html#cfn-imagebuilder-image-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-image.html#cfn-imagebuilder-image-executionrole

ImageRecipeArn

The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.

public string ImageRecipeArn { get; set; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html#cfn-imagebuilder-image-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-image.html#cfn-imagebuilder-image-imagescanningconfiguration

ImageTestsConfiguration

The image tests configuration of the image.

public object ImageTestsConfiguration { get; set; }

Property Value

System.Object

Remarks

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

InfrastructureConfigurationArn

The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.

public string InfrastructureConfigurationArn { get; set; }

Property Value

System.String

Remarks

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

Tags

The tags of the image.

public IDictionary<string, string> Tags { get; set; }

Property Value

System.Collections.Generic.IDictionary<System.String, System.String>

Remarks

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

Workflows

Contains an array of workflow configuration objects.

public object Workflows { get; set; }

Property Value

System.Object

Remarks

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

Implements

ICfnImageProps