Class CfnImageRecipe
A CloudFormation AWS::ImageBuilder::ImageRecipe
.
Inherited Members
Namespace: Amazon.CDK.AWS.ImageBuilder
Assembly: Amazon.CDK.AWS.ImageBuilder.dll
Syntax (csharp)
public class CfnImageRecipe : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnImageRecipe
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
An Image Builder image recipe is a document that defines the base image and the components to be applied to the base image to produce the desired configuration for the output image. You can use an image recipe to duplicate builds. Image Builder image recipes can be shared, branched, and edited using the console wizard, the AWS CLI , or the API. You can use image recipes with your version control software to maintain shareable versioned image recipes.
CloudformationResource: AWS::ImageBuilder::ImageRecipe
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 cfnImageRecipe = new CfnImageRecipe(this, "MyCfnImageRecipe", 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
CfnImageRecipe(Construct, String, ICfnImageRecipeProps) | Create a new |
CfnImageRecipe(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnImageRecipe(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AdditionalInstanceConfiguration | Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration. |
AttrArn | Returns the Amazon Resource Name (ARN) of the image recipe. |
AttrName | The name of the image recipe. |
BlockDeviceMappings | The block device mappings to apply when creating images from this recipe. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnImageRecipe(Construct, String, ICfnImageRecipeProps)
Create a new AWS::ImageBuilder::ImageRecipe
.
public CfnImageRecipe(Construct scope, string id, ICfnImageRecipeProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnImageRecipeProps
- resource properties.
CfnImageRecipe(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnImageRecipe(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnImageRecipe(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnImageRecipe(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AdditionalInstanceConfiguration
Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration.
public virtual 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.
AttrArn
Returns the Amazon Resource Name (ARN) of the image recipe.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
For example, arn:aws:imagebuilder:us-east-1:123456789012:image-recipe/mybasicrecipe/2019.12.03
.
CloudformationAttribute: Arn
AttrName
The name of the image recipe.
public virtual string AttrName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Name
BlockDeviceMappings
The block device mappings to apply when creating images from this recipe.
public virtual object BlockDeviceMappings { get; set; }
Property Value
System.Object
Remarks
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Components
The components of the image recipe.
public virtual 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 virtual string Description { get; set; }
Property Value
System.String
Remarks
Name
The name of the image recipe.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
ParentImage
The parent image of the image recipe.
public virtual 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 virtual TagManager Tags { get; }
Property Value
Remarks
Version
The semantic version of the image recipe.
public virtual string Version { get; set; }
Property Value
System.String
Remarks
WorkingDirectory
The working directory to be used during build and test workflows.
public virtual string WorkingDirectory { get; set; }
Property Value
System.String
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>