AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateImageRecipe operation. Creates a new image recipe. Image recipes define how images are configured, tested, and assessed.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Imagebuilder.AmazonImagebuilderRequest
      Amazon.Imagebuilder.Model.CreateImageRecipeRequest

Namespace: Amazon.Imagebuilder.Model
Assembly: AWSSDK.Imagebuilder.dll
Version: 3.x.y.z

Syntax

C# 
public class CreateImageRecipeRequest : AmazonImagebuilderRequest
         IAmazonWebServiceRequest

The CreateImageRecipeRequest type exposes the following members

Constructors

NameDescription
Public Method CreateImageRecipeRequest()

Properties

NameTypeDescription
Public Property AdditionalInstanceConfiguration Amazon.Imagebuilder.Model.AdditionalInstanceConfiguration

Gets and sets the property AdditionalInstanceConfiguration.

Specify additional settings and launch scripts for your build instances.

Public Property BlockDeviceMappings System.Collections.Generic.List<Amazon.Imagebuilder.Model.InstanceBlockDeviceMapping>

Gets and sets the property BlockDeviceMappings.

The block device mappings of the image recipe.

Public Property ClientToken System.String

Gets and sets the property ClientToken.

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

Public Property Components System.Collections.Generic.List<Amazon.Imagebuilder.Model.ComponentConfiguration>

Gets and sets the property Components.

The components included in the image recipe.

Public Property Description System.String

Gets and sets the property Description.

The description of the image recipe.

Public Property Name System.String

Gets and sets the property Name.

The name of the image recipe.

Public Property ParentImage System.String

Gets and sets the property ParentImage.

The base image of the image recipe. The value of the string can be the ARN of the base image or an AMI ID. The format for the ARN follows this example: arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x. You can provide the specific version that you want to use, or you can use a wildcard in all of the fields. If you enter an AMI ID for the string value, you must have access to the AMI, and the AMI must be in the same Region in which you are using Image Builder.

Public Property SemanticVersion System.String

Gets and sets the property SemanticVersion.

The semantic version of the image recipe. This version follows the semantic version syntax.

The semantic version has four nodes: ../. You can assign values for the first three, and can filter on all of them.

Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

Public Property Tags System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property Tags.

The tags of the image recipe.

Public Property WorkingDirectory System.String

Gets and sets the property WorkingDirectory.

The working directory used during build and test workflows.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5