Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-imagebuilder-imagerecipe.json
Parent schema serverless-framework-configuration
Type: object

Resource schema for AWS::ImageBuilder::ImageRecipe. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-imagebuilder.git

Properties

Name string | Aws_CF_FunctionString required

The name of the image recipe.

Version string | Aws_CF_FunctionString required

The version of the image recipe.

Components ComponentConfiguration[] required

The components of the image recipe.

ParentImage string | Aws_CF_FunctionString required

The parent image of the image recipe.

Description string | Aws_CF_FunctionString

The description of the image recipe.

BlockDeviceMappings InstanceBlockDeviceMapping[]

The block device mappings to apply when creating images from this recipe.

WorkingDirectory string | Aws_CF_FunctionString

The working directory to be used during build and test workflows.

AdditionalInstanceConfiguration object

Specify additional settings and launch scripts for your build instances.

2 nested properties
SystemsManagerAgent object

Contains settings for the SSM agent on your build instance.

1 nested properties
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.

UserDataOverride string | Aws_CF_FunctionString

Use this property to provide commands or a command script to run when you launch your build instance.

Tags object

The tags of the image recipe.

Definitions

ComponentConfiguration object

Configuration details of the component.

ComponentArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the component.

A group of parameter settings that are used to configure the component for a specific recipe.

InstanceBlockDeviceMapping object

Defines block device mappings for the instance used to configure your image.

DeviceName string | Aws_CF_FunctionString

The device to which these mappings apply.

VirtualName string | Aws_CF_FunctionString

Use to manage instance ephemeral devices.

NoDevice string | Aws_CF_FunctionString

Use to remove a mapping from the parent image.

Ebs object

Amazon EBS-specific block device mapping specifications.

8 nested properties
Encrypted boolean

Use to configure device encryption.

DeleteOnTermination boolean

Use to configure delete on termination of the associated device.

Iops integer

Use to configure device IOPS.

KmsKeyId string | Aws_CF_FunctionString

Use to configure the KMS key to use when encrypting the device.

SnapshotId string | Aws_CF_FunctionString

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 string | Aws_CF_FunctionString

Use to override the device's volume type.

EbsInstanceBlockDeviceSpecification object

Amazon EBS-specific block device mapping specifications.

Encrypted boolean

Use to configure device encryption.

DeleteOnTermination boolean

Use to configure delete on termination of the associated device.

Iops integer

Use to configure device IOPS.

KmsKeyId string | Aws_CF_FunctionString

Use to configure the KMS key to use when encrypting the device.

SnapshotId string | Aws_CF_FunctionString

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 string | Aws_CF_FunctionString

Use to override the device's volume type.

AdditionalInstanceConfiguration object

Specify additional settings and launch scripts for your build instances.

SystemsManagerAgent object

Contains settings for the SSM agent on your build instance.

1 nested properties
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.

UserDataOverride string | Aws_CF_FunctionString

Use this property to provide commands or a command script to run when you launch your build instance.

SystemsManagerAgent object

Contains settings for the SSM agent on your build instance.

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.

ComponentParameter object

Contains a key/value pair that sets the named component parameter.

Name string | Aws_CF_FunctionString required

The name of the component parameter to set.

Value string[] required

Sets the value for the named component parameter.