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

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

Properties

Name string | Aws_CF_FunctionString

The name of the container recipe.

Description string | Aws_CF_FunctionString

The description of the container recipe.

Version string | Aws_CF_FunctionString

The semantic version of the container recipe (..).

Components for build and test that are included in the container recipe.

InstanceConfiguration object

A group of options that can be used to configure an instance for building and testing container images.

2 nested properties
Image string | Aws_CF_FunctionString

The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.

BlockDeviceMappings InstanceBlockDeviceMapping[]

Defines the block devices to attach for building an instance from this Image Builder AMI.

DockerfileTemplateData string | Aws_CF_FunctionString

Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.

DockerfileTemplateUri string | Aws_CF_FunctionString

The S3 URI for the Dockerfile that will be used to build your container image.

PlatformOverride string | Aws_CF_FunctionString

Specifies the operating system platform when you use a custom source image.

ContainerType string | Aws_CF_FunctionString

Specifies the type of container, such as Docker.

ImageOsVersionOverride string | Aws_CF_FunctionString

Specifies the operating system version for the source image.

TargetRepository object

The container repository where the output container image is stored.

2 nested properties
Service string | Aws_CF_FunctionString

Specifies the service in which this image was registered.

RepositoryName string | Aws_CF_FunctionString

The name of the container repository where the output container image is stored. This name is prefixed by the repository location.

KmsKeyId string | Aws_CF_FunctionString

Identifies which KMS key is used to encrypt the container image.

ParentImage string | Aws_CF_FunctionString

The source image for the container recipe.

WorkingDirectory string | Aws_CF_FunctionString

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

Tags object

Tags that are attached to the container recipe.

One of

1. variant
2. variant

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.

InstanceConfiguration object

A group of options that can be used to configure an instance for building and testing container images.

Image string | Aws_CF_FunctionString

The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.

BlockDeviceMappings InstanceBlockDeviceMapping[]

Defines the block devices to attach for building an instance from this Image Builder AMI.

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.

TargetContainerRepository object

The container repository where the output container image is stored.

Service string | Aws_CF_FunctionString

Specifies the service in which this image was registered.

RepositoryName string | Aws_CF_FunctionString

The name of the container repository where the output container image is stored. This name is prefixed by the repository location.

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.