Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. imagebuilder
  5. ImageRecipe

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.imagebuilder.ImageRecipe

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource schema for AWS::ImageBuilder::ImageRecipe

Create ImageRecipe Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ImageRecipe(name: string, args: ImageRecipeArgs, opts?: CustomResourceOptions);
@overload
def ImageRecipe(resource_name: str,
                args: ImageRecipeArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def ImageRecipe(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                components: Optional[Sequence[ImageRecipeComponentConfigurationArgs]] = None,
                parent_image: Optional[str] = None,
                version: Optional[str] = None,
                additional_instance_configuration: Optional[ImageRecipeAdditionalInstanceConfigurationArgs] = None,
                block_device_mappings: Optional[Sequence[ImageRecipeInstanceBlockDeviceMappingArgs]] = None,
                description: Optional[str] = None,
                name: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None,
                working_directory: Optional[str] = None)
func NewImageRecipe(ctx *Context, name string, args ImageRecipeArgs, opts ...ResourceOption) (*ImageRecipe, error)
public ImageRecipe(string name, ImageRecipeArgs args, CustomResourceOptions? opts = null)
public ImageRecipe(String name, ImageRecipeArgs args)
public ImageRecipe(String name, ImageRecipeArgs args, CustomResourceOptions options)

type: aws-native:imagebuilder:ImageRecipe
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ImageRecipeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ImageRecipeArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ImageRecipeArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ImageRecipeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ImageRecipeArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

ImageRecipe Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ImageRecipe resource accepts the following input properties:

Components This property is required. List<Pulumi.AwsNative.ImageBuilder.Inputs.ImageRecipeComponentConfiguration>
The components of the image recipe.
ParentImage This property is required. string
The parent image of the image recipe.
Version This property is required. string
The version of the image recipe.
AdditionalInstanceConfiguration Pulumi.AwsNative.ImageBuilder.Inputs.ImageRecipeAdditionalInstanceConfiguration
Specify additional settings and launch scripts for your build instances.
BlockDeviceMappings List<Pulumi.AwsNative.ImageBuilder.Inputs.ImageRecipeInstanceBlockDeviceMapping>
The block device mappings to apply when creating images from this recipe.
Description string
The description of the image recipe.
Name string
The name of the image recipe.
Tags Dictionary<string, string>
The tags of the image recipe.
WorkingDirectory string
The working directory to be used during build and test workflows.
Components This property is required. []ImageRecipeComponentConfigurationArgs
The components of the image recipe.
ParentImage This property is required. string
The parent image of the image recipe.
Version This property is required. string
The version of the image recipe.
AdditionalInstanceConfiguration ImageRecipeAdditionalInstanceConfigurationArgs
Specify additional settings and launch scripts for your build instances.
BlockDeviceMappings []ImageRecipeInstanceBlockDeviceMappingArgs
The block device mappings to apply when creating images from this recipe.
Description string
The description of the image recipe.
Name string
The name of the image recipe.
Tags map[string]string
The tags of the image recipe.
WorkingDirectory string
The working directory to be used during build and test workflows.
components This property is required. List<ImageRecipeComponentConfiguration>
The components of the image recipe.
parentImage This property is required. String
The parent image of the image recipe.
version This property is required. String
The version of the image recipe.
additionalInstanceConfiguration ImageRecipeAdditionalInstanceConfiguration
Specify additional settings and launch scripts for your build instances.
blockDeviceMappings List<ImageRecipeInstanceBlockDeviceMapping>
The block device mappings to apply when creating images from this recipe.
description String
The description of the image recipe.
name String
The name of the image recipe.
tags Map<String,String>
The tags of the image recipe.
workingDirectory String
The working directory to be used during build and test workflows.
components This property is required. ImageRecipeComponentConfiguration[]
The components of the image recipe.
parentImage This property is required. string
The parent image of the image recipe.
version This property is required. string
The version of the image recipe.
additionalInstanceConfiguration ImageRecipeAdditionalInstanceConfiguration
Specify additional settings and launch scripts for your build instances.
blockDeviceMappings ImageRecipeInstanceBlockDeviceMapping[]
The block device mappings to apply when creating images from this recipe.
description string
The description of the image recipe.
name string
The name of the image recipe.
tags {[key: string]: string}
The tags of the image recipe.
workingDirectory string
The working directory to be used during build and test workflows.
components This property is required. Sequence[ImageRecipeComponentConfigurationArgs]
The components of the image recipe.
parent_image This property is required. str
The parent image of the image recipe.
version This property is required. str
The version of the image recipe.
additional_instance_configuration ImageRecipeAdditionalInstanceConfigurationArgs
Specify additional settings and launch scripts for your build instances.
block_device_mappings Sequence[ImageRecipeInstanceBlockDeviceMappingArgs]
The block device mappings to apply when creating images from this recipe.
description str
The description of the image recipe.
name str
The name of the image recipe.
tags Mapping[str, str]
The tags of the image recipe.
working_directory str
The working directory to be used during build and test workflows.
components This property is required. List<Property Map>
The components of the image recipe.
parentImage This property is required. String
The parent image of the image recipe.
version This property is required. String
The version of the image recipe.
additionalInstanceConfiguration Property Map
Specify additional settings and launch scripts for your build instances.
blockDeviceMappings List<Property Map>
The block device mappings to apply when creating images from this recipe.
description String
The description of the image recipe.
name String
The name of the image recipe.
tags Map<String>
The tags of the image recipe.
workingDirectory String
The working directory to be used during build and test workflows.

Outputs

All input properties are implicitly available as output properties. Additionally, the ImageRecipe resource produces the following output properties:

Arn string
The Amazon Resource Name (ARN) of the image recipe.
Id string
The provider-assigned unique ID for this managed resource.
Arn string
The Amazon Resource Name (ARN) of the image recipe.
Id string
The provider-assigned unique ID for this managed resource.
arn String
The Amazon Resource Name (ARN) of the image recipe.
id String
The provider-assigned unique ID for this managed resource.
arn string
The Amazon Resource Name (ARN) of the image recipe.
id string
The provider-assigned unique ID for this managed resource.
arn str
The Amazon Resource Name (ARN) of the image recipe.
id str
The provider-assigned unique ID for this managed resource.
arn String
The Amazon Resource Name (ARN) of the image recipe.
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

ImageRecipeAdditionalInstanceConfiguration
, ImageRecipeAdditionalInstanceConfigurationArgs

SystemsManagerAgent Pulumi.AwsNative.ImageBuilder.Inputs.ImageRecipeSystemsManagerAgent
Contains settings for the SSM agent on your build instance.
UserDataOverride string
Use this property to provide commands or a command script to run when you launch your build instance.
SystemsManagerAgent ImageRecipeSystemsManagerAgent
Contains settings for the SSM agent on your build instance.
UserDataOverride string
Use this property to provide commands or a command script to run when you launch your build instance.
systemsManagerAgent ImageRecipeSystemsManagerAgent
Contains settings for the SSM agent on your build instance.
userDataOverride String
Use this property to provide commands or a command script to run when you launch your build instance.
systemsManagerAgent ImageRecipeSystemsManagerAgent
Contains settings for the SSM agent on your build instance.
userDataOverride string
Use this property to provide commands or a command script to run when you launch your build instance.
systems_manager_agent ImageRecipeSystemsManagerAgent
Contains settings for the SSM agent on your build instance.
user_data_override str
Use this property to provide commands or a command script to run when you launch your build instance.
systemsManagerAgent Property Map
Contains settings for the SSM agent on your build instance.
userDataOverride String
Use this property to provide commands or a command script to run when you launch your build instance.

ImageRecipeComponentConfiguration
, ImageRecipeComponentConfigurationArgs

ComponentArn string
The Amazon Resource Name (ARN) of the component.
Parameters List<Pulumi.AwsNative.ImageBuilder.Inputs.ImageRecipeComponentParameter>
A group of parameter settings that are used to configure the component for a specific recipe.
ComponentArn string
The Amazon Resource Name (ARN) of the component.
Parameters []ImageRecipeComponentParameter
A group of parameter settings that are used to configure the component for a specific recipe.
componentArn String
The Amazon Resource Name (ARN) of the component.
parameters List<ImageRecipeComponentParameter>
A group of parameter settings that are used to configure the component for a specific recipe.
componentArn string
The Amazon Resource Name (ARN) of the component.
parameters ImageRecipeComponentParameter[]
A group of parameter settings that are used to configure the component for a specific recipe.
component_arn str
The Amazon Resource Name (ARN) of the component.
parameters Sequence[ImageRecipeComponentParameter]
A group of parameter settings that are used to configure the component for a specific recipe.
componentArn String
The Amazon Resource Name (ARN) of the component.
parameters List<Property Map>
A group of parameter settings that are used to configure the component for a specific recipe.

ImageRecipeComponentParameter
, ImageRecipeComponentParameterArgs

Name This property is required. string
The name of the component parameter to set.
Value This property is required. List<string>
Sets the value for the named component parameter.
Name This property is required. string
The name of the component parameter to set.
Value This property is required. []string
Sets the value for the named component parameter.
name This property is required. String
The name of the component parameter to set.
value This property is required. List<String>
Sets the value for the named component parameter.
name This property is required. string
The name of the component parameter to set.
value This property is required. string[]
Sets the value for the named component parameter.
name This property is required. str
The name of the component parameter to set.
value This property is required. Sequence[str]
Sets the value for the named component parameter.
name This property is required. String
The name of the component parameter to set.
value This property is required. List<String>
Sets the value for the named component parameter.

ImageRecipeEbsInstanceBlockDeviceSpecification
, ImageRecipeEbsInstanceBlockDeviceSpecificationArgs

DeleteOnTermination bool
Use to configure delete on termination of the associated device.
Encrypted bool
Use to configure device encryption.
Iops int
Use to configure device IOPS.
KmsKeyId string
Use to configure the KMS key to use when encrypting the device.
SnapshotId string
The snapshot that defines the device contents.
Throughput int
For GP3 volumes only - The throughput in MiB/s that the volume supports.
VolumeSize int
Use to override the device's volume size.
VolumeType Pulumi.AwsNative.ImageBuilder.ImageRecipeEbsInstanceBlockDeviceSpecificationVolumeType
Use to override the device's volume type.
DeleteOnTermination bool
Use to configure delete on termination of the associated device.
Encrypted bool
Use to configure device encryption.
Iops int
Use to configure device IOPS.
KmsKeyId string
Use to configure the KMS key to use when encrypting the device.
SnapshotId string
The snapshot that defines the device contents.
Throughput int
For GP3 volumes only - The throughput in MiB/s that the volume supports.
VolumeSize int
Use to override the device's volume size.
VolumeType ImageRecipeEbsInstanceBlockDeviceSpecificationVolumeType
Use to override the device's volume type.
deleteOnTermination Boolean
Use to configure delete on termination of the associated device.
encrypted Boolean
Use to configure device encryption.
iops Integer
Use to configure device IOPS.
kmsKeyId String
Use to configure the KMS key to use when encrypting the device.
snapshotId String
The snapshot that defines the device contents.
throughput Integer
For GP3 volumes only - The throughput in MiB/s that the volume supports.
volumeSize Integer
Use to override the device's volume size.
volumeType ImageRecipeEbsInstanceBlockDeviceSpecificationVolumeType
Use to override the device's volume type.
deleteOnTermination boolean
Use to configure delete on termination of the associated device.
encrypted boolean
Use to configure device encryption.
iops number
Use to configure device IOPS.
kmsKeyId string
Use to configure the KMS key to use when encrypting the device.
snapshotId string
The snapshot that defines the device contents.
throughput number
For GP3 volumes only - The throughput in MiB/s that the volume supports.
volumeSize number
Use to override the device's volume size.
volumeType ImageRecipeEbsInstanceBlockDeviceSpecificationVolumeType
Use to override the device's volume type.
delete_on_termination bool
Use to configure delete on termination of the associated device.
encrypted bool
Use to configure device encryption.
iops int
Use to configure device IOPS.
kms_key_id str
Use to configure the KMS key to use when encrypting the device.
snapshot_id str
The snapshot that defines the device contents.
throughput int
For GP3 volumes only - The throughput in MiB/s that the volume supports.
volume_size int
Use to override the device's volume size.
volume_type ImageRecipeEbsInstanceBlockDeviceSpecificationVolumeType
Use to override the device's volume type.
deleteOnTermination Boolean
Use to configure delete on termination of the associated device.
encrypted Boolean
Use to configure device encryption.
iops Number
Use to configure device IOPS.
kmsKeyId String
Use to configure the KMS key to use when encrypting the device.
snapshotId String
The snapshot that defines the device contents.
throughput Number
For GP3 volumes only - The throughput in MiB/s that the volume supports.
volumeSize Number
Use to override the device's volume size.
volumeType "standard" | "io1" | "io2" | "gp2" | "gp3" | "sc1" | "st1"
Use to override the device's volume type.

ImageRecipeEbsInstanceBlockDeviceSpecificationVolumeType
, ImageRecipeEbsInstanceBlockDeviceSpecificationVolumeTypeArgs

Standard
standard
Io1
io1
Io2
io2
Gp2
gp2
Gp3
gp3
Sc1
sc1
St1
st1
ImageRecipeEbsInstanceBlockDeviceSpecificationVolumeTypeStandard
standard
ImageRecipeEbsInstanceBlockDeviceSpecificationVolumeTypeIo1
io1
ImageRecipeEbsInstanceBlockDeviceSpecificationVolumeTypeIo2
io2
ImageRecipeEbsInstanceBlockDeviceSpecificationVolumeTypeGp2
gp2
ImageRecipeEbsInstanceBlockDeviceSpecificationVolumeTypeGp3
gp3
ImageRecipeEbsInstanceBlockDeviceSpecificationVolumeTypeSc1
sc1
ImageRecipeEbsInstanceBlockDeviceSpecificationVolumeTypeSt1
st1
Standard
standard
Io1
io1
Io2
io2
Gp2
gp2
Gp3
gp3
Sc1
sc1
St1
st1
Standard
standard
Io1
io1
Io2
io2
Gp2
gp2
Gp3
gp3
Sc1
sc1
St1
st1
STANDARD
standard
IO1
io1
IO2
io2
GP2
gp2
GP3
gp3
SC1
sc1
ST1
st1
"standard"
standard
"io1"
io1
"io2"
io2
"gp2"
gp2
"gp3"
gp3
"sc1"
sc1
"st1"
st1

ImageRecipeInstanceBlockDeviceMapping
, ImageRecipeInstanceBlockDeviceMappingArgs

DeviceName string
The device to which these mappings apply.
Ebs Pulumi.AwsNative.ImageBuilder.Inputs.ImageRecipeEbsInstanceBlockDeviceSpecification
Use to manage Amazon EBS-specific configuration for this mapping.
NoDevice string
Use to remove a mapping from the parent image.
VirtualName string
Use to manage instance ephemeral devices.
DeviceName string
The device to which these mappings apply.
Ebs ImageRecipeEbsInstanceBlockDeviceSpecification
Use to manage Amazon EBS-specific configuration for this mapping.
NoDevice string
Use to remove a mapping from the parent image.
VirtualName string
Use to manage instance ephemeral devices.
deviceName String
The device to which these mappings apply.
ebs ImageRecipeEbsInstanceBlockDeviceSpecification
Use to manage Amazon EBS-specific configuration for this mapping.
noDevice String
Use to remove a mapping from the parent image.
virtualName String
Use to manage instance ephemeral devices.
deviceName string
The device to which these mappings apply.
ebs ImageRecipeEbsInstanceBlockDeviceSpecification
Use to manage Amazon EBS-specific configuration for this mapping.
noDevice string
Use to remove a mapping from the parent image.
virtualName string
Use to manage instance ephemeral devices.
device_name str
The device to which these mappings apply.
ebs ImageRecipeEbsInstanceBlockDeviceSpecification
Use to manage Amazon EBS-specific configuration for this mapping.
no_device str
Use to remove a mapping from the parent image.
virtual_name str
Use to manage instance ephemeral devices.
deviceName String
The device to which these mappings apply.
ebs Property Map
Use to manage Amazon EBS-specific configuration for this mapping.
noDevice String
Use to remove a mapping from the parent image.
virtualName String
Use to manage instance ephemeral devices.

ImageRecipeSystemsManagerAgent
, ImageRecipeSystemsManagerAgentArgs

UninstallAfterBuild bool
Controls whether the SSM agent is removed from your final build image, prior to creating the new AMI. If this is set to true, then the agent is removed from the final image. If it's set to false, then the agent is left in, so that it is included in the new AMI. The default value is false.
UninstallAfterBuild bool
Controls whether the SSM agent is removed from your final build image, prior to creating the new AMI. If this is set to true, then the agent is removed from the final image. If it's set to false, then the agent is left in, so that it is included in the new AMI. The default value is false.
uninstallAfterBuild Boolean
Controls whether the SSM agent is removed from your final build image, prior to creating the new AMI. If this is set to true, then the agent is removed from the final image. If it's set to false, then the agent is left in, so that it is included in the new AMI. The default value is false.
uninstallAfterBuild boolean
Controls whether the SSM agent is removed from your final build image, prior to creating the new AMI. If this is set to true, then the agent is removed from the final image. If it's set to false, then the agent is left in, so that it is included in the new AMI. The default value is false.
uninstall_after_build bool
Controls whether the SSM agent is removed from your final build image, prior to creating the new AMI. If this is set to true, then the agent is removed from the final image. If it's set to false, then the agent is left in, so that it is included in the new AMI. The default value is false.
uninstallAfterBuild Boolean
Controls whether the SSM agent is removed from your final build image, prior to creating the new AMI. If this is set to true, then the agent is removed from the final image. If it's set to false, then the agent is left in, so that it is included in the new AMI. The default value is false.

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native