Interface ICfnImageProps

Properties for defining a CfnImage.

Namespace: Amazon.CDK.AWS.ImageBuilder

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnImageProps

Syntax (vb)

Public Interface 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

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.

Properties

ContainerRecipeArn

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

string? ContainerRecipeArn { get; }

Property Value

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.

string? DistributionConfigurationArn { get; }

Property Value

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.

object? EnhancedImageMetadataEnabled { get; }

Property Value

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.

string? ExecutionRole { get; }

Property Value

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.

string? ImageRecipeArn { get; }

Property Value

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.

object? ImageScanningConfiguration { get; }

Property Value

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.

object? ImageTestsConfiguration { get; }

Property Value

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.

string? InfrastructureConfigurationArn { get; }

Property Value

string

Remarks

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

Workflows

Contains an array of workflow configuration objects.

object? Workflows { get; }

Property Value

object

Remarks

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