Class CfnImageProps

Properties for defining a CfnImage.

Inheritance

System.Object

CfnImageProps

Implements

ICfnImageProps

Namespace: Amazon.CDK.AWS.ImageBuilder

Assembly: Amazon.CDK.AWS.ImageBuilder.dll

Syntax (csharp)

public class CfnImageProps : Object, ICfnImageProps

Syntax (vb)

Public Class CfnImageProps
    Inherits Object
    Implements ICfnImageProps

Remarks

Link: 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 {
    InfrastructureConfigurationArn = "infrastructureConfigurationArn",

    // the properties below are optional
    ContainerRecipeArn = "containerRecipeArn",
    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
    },
    Tags = new Dictionary<string, string> {
        { "tagsKey", "tags" }
    }
};

Synopsis

Constructors

CfnImageProps()

Properties

ContainerRecipeArn	The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
DistributionConfigurationArn	The Amazon Resource Name (ARN) of the distribution configuration.
EnhancedImageMetadataEnabled	Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.
ImageRecipeArn	The Amazon Resource Name (ARN) of the image recipe.
ImageScanningConfiguration	AWS::ImageBuilder::Image.ImageScanningConfiguration.
ImageTestsConfiguration	The configuration settings for your image test components, which includes a toggle that allows you to turn off tests, and a timeout setting.
InfrastructureConfigurationArn	The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
Tags	The tags of the image.

Constructors

CfnImageProps()

public CfnImageProps()

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

Link: 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.

public string DistributionConfigurationArn { get; set; }

Property Value

System.String

Remarks

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

EnhancedImageMetadataEnabled

Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.

public object EnhancedImageMetadataEnabled { get; set; }

Property Value

System.Object

Remarks

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

ImageRecipeArn

The Amazon Resource Name (ARN) of the image recipe.

public string ImageRecipeArn { get; set; }

Property Value

System.String

Remarks

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

ImageScanningConfiguration

AWS::ImageBuilder::Image.ImageScanningConfiguration.

public object ImageScanningConfiguration { get; set; }

Property Value

System.Object

Remarks

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

ImageTestsConfiguration

The configuration settings for your image test components, which includes a toggle that allows you to turn off tests, and a timeout setting.

public object ImageTestsConfiguration { get; set; }

Property Value

System.Object

Remarks

Link: 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 associated with this image pipeline.

public string InfrastructureConfigurationArn { get; set; }

Property Value

System.String

Remarks

Link: 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

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

Implements

ICfnImageProps