Class CfnImageRecipeProps
Properties for defining a CfnImageRecipe
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.ImageBuilder
Assembly: Amazon.CDK.AWS.ImageBuilder.dll
Syntax (csharp)
public class CfnImageRecipeProps : Object, ICfnImageRecipeProps
Syntax (vb)
Public Class CfnImageRecipeProps
Inherits Object
Implements ICfnImageRecipeProps
Remarks
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 cfnImageRecipeProps = new CfnImageRecipeProps {
Components = new [] { new ComponentConfigurationProperty {
ComponentArn = "componentArn",
Parameters = new [] { new ComponentParameterProperty {
Name = "name",
Value = new [] { "value" }
} }
} },
Name = "name",
ParentImage = "parentImage",
Version = "version",
// the properties below are optional
AdditionalInstanceConfiguration = new AdditionalInstanceConfigurationProperty {
SystemsManagerAgent = new SystemsManagerAgentProperty {
UninstallAfterBuild = false
},
UserDataOverride = "userDataOverride"
},
BlockDeviceMappings = new [] { new InstanceBlockDeviceMappingProperty {
DeviceName = "deviceName",
Ebs = new EbsInstanceBlockDeviceSpecificationProperty {
DeleteOnTermination = false,
Encrypted = false,
Iops = 123,
KmsKeyId = "kmsKeyId",
SnapshotId = "snapshotId",
Throughput = 123,
VolumeSize = 123,
VolumeType = "volumeType"
},
NoDevice = "noDevice",
VirtualName = "virtualName"
} },
Description = "description",
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
},
WorkingDirectory = "workingDirectory"
};
Synopsis
Constructors
CfnImageRecipeProps() |
Properties
AdditionalInstanceConfiguration | Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration. |
BlockDeviceMappings | The block device mappings to apply when creating images from this recipe. |
Components | The components of the image recipe. |
Description | The description of the image recipe. |
Name | The name of the image recipe. |
ParentImage | The parent image of the image recipe. |
Tags | The tags of the image recipe. |
Version | The semantic version of the image recipe. |
WorkingDirectory | The working directory to be used during build and test workflows. |
Constructors
CfnImageRecipeProps()
public CfnImageRecipeProps()
Properties
AdditionalInstanceConfiguration
Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration.
public object AdditionalInstanceConfiguration { get; set; }
Property Value
System.Object
Remarks
Instance configuration adds a layer of control over those instances. You can define settings and add scripts to run when an instance is launched from your AMI.
BlockDeviceMappings
The block device mappings to apply when creating images from this recipe.
public object BlockDeviceMappings { get; set; }
Property Value
System.Object
Remarks
Components
The components of the image recipe.
public object Components { get; set; }
Property Value
System.Object
Remarks
Components are orchestration documents that define a sequence of steps for downloading, installing, configuring, and testing software packages. They also define validation and security hardening steps. A component is defined using a YAML document format.
Description
The description of the image recipe.
public string Description { get; set; }
Property Value
System.String
Remarks
Name
The name of the image recipe.
public string Name { get; set; }
Property Value
System.String
Remarks
ParentImage
The parent image of the image recipe.
public string ParentImage { get; set; }
Property Value
System.String
Remarks
The string must be either an Image ARN or an AMI ID.
Tags
The tags of the image recipe.
public IDictionary<string, string> Tags { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
Version
The semantic version of the image recipe.
public string Version { get; set; }
Property Value
System.String
Remarks
WorkingDirectory
The working directory to be used during build and test workflows.
public string WorkingDirectory { get; set; }
Property Value
System.String