The semantic version of the container recipe. This version follows the semantic version syntax.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. 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.
'
type: string
pattern: ^[0-9]+\.[0-9]+\.[0-9]+$
components:
description: Components for build and test that are included in the container recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.
type: array
items:
$ref: '#/components/schemas/ComponentConfiguration'
minItems: 1
instanceConfiguration:
description: Defines a custom base AMI and block device mapping configurations of an instance used for building and testing container images.
type: object
properties:
image:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: 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:
allOf:
- $ref: '#/components/schemas/InstanceBlockDeviceMappings'
- description: Defines the block devices to attach for building an instance from this Image Builder AMI.
dockerfileTemplateData:
description: The Dockerfile template used to build your image as an inline data blob.
type: string
pattern: '[^\x00]+'
minLength: 1
maxLength: 16000
dockerfileTemplateUri:
description: The Amazon S3 URI for the Dockerfile that will be used to build your container image.
type: string
platformOverride:
description: Specifies the operating system platform when you use a custom base image.
type: string
enum:
- Windows
- Linux
imageOsVersionOverride:
description: Specifies the operating system version for the base image.
type: string
minLength: 1
maxLength: 1024
parentImage:
description: The base image for the container recipe.
type: string
minLength: 1
maxLength: 1024
tags:
description: Tags that are attached to the container recipe.
type: object
minProperties: 1
maxProperties: 50
additionalProperties:
$ref: '#/components/schemas/TagValue'
workingDirectory:
description: The working directory for use during build and test workflows.
type: string
minLength: 1
maxLength: 1024
targetRepository:
description: The container repository where the output container image is stored.
type: object
properties:
service:
allOf:
- $ref: '#/components/schemas/ContainerRepositoryService'
- description: Specifies the service in which this image was registered.
repositoryName:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The name of the container repository where the output container image is stored. This name is prefixed by the repository location.
kmsKeyId:
description: Identifies which KMS key is used to encrypt the container image.
type: string
minLength: 1
maxLength: 1024
clientToken:
description: The client token used to make this request idempotent.
type: string
minLength: 1
maxLength: 36
summary: Amazon EC2 Image Builder Create Container Recipe
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- CreateContainerRecipe
components:
parameters:
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
schemas:
EbsVolumeType:
type: string
enum:
- standard
- io1
- io2
- gp2
- gp3
- sc1
- st1
NonEmptyString:
type: string
minLength: 1
maxLength: 1024
InvalidVersionNumberException: {}
ComponentVersionArnOrBuildVersionArn:
type: string
pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):component/[a-z0-9-_]+/(?:(?:([0-9]+|x)\.([0-9]+|x)\.([0-9]+|x))|(?:[0-9]+\.[0-9]+\.[0-9]+/[0-9]+))$
ServiceException: {}
ForbiddenException: {}
EbsVolumeSizeInteger:
type: integer
minimum: 1
maximum: 16000
ServiceUnavailableException: {}
ComponentParameterValue:
type: string
pattern: '[^\x00]*'
minLength: 0
ResourceAlreadyExistsException: {}
ComponentParameterName:
type: string
pattern: '[^\x00]+'
minLength: 1
maxLength: 256
EmptyString:
type: string
minLength: 0
maxLength: 0
IdempotentParameterMismatchException: {}
CallRateLimitExceededException: {}
TagValue:
type: string
maxLength: 256
ClientToken:
type: string
minLength: 1
maxLength: 36
ComponentConfiguration:
type: object
required:
- componentArn
properties:
componentArn:
allOf:
- $ref: '#/components/schemas/ComponentVersionArnOrBuildVersionArn'
- description: The Amazon Resource Name (ARN) of the component.
example: arn:aws:service:us-east-1:123456789012:resource/example
parameters:
allOf:
- $ref: '#/components/schemas/ComponentParameterList'
- description: A group of parameter settings that Image Builder uses to configure the component for a specific recipe.
example: example-string
description: Configuration details of the component.
InstanceBlockDeviceMapping:
type: object
properties:
deviceName:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The device to which these mappings apply.
example: example-resource-name
ebs:
allOf:
- $ref: '#/components/schemas/EbsInstanceBlockDeviceSpecification'
- description: Use to manage Amazon EBS-specific configuration for this mapping.
example: example-string
virtualName:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: Use to manage instance ephemeral devices.
example: example-resource-name
noDevice:
allOf:
- $ref: '#/components/schemas/EmptyString'
- description: Use to remove a mapping from the base image.
example: example-string
description: Defines block device mappings for the instance used to configure your image.
EbsIopsInteger:
type: integer
minimum: 100
maximum: 64000
EbsInstanceBlockDeviceSpecification:
type: object
properties:
encrypted:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: Use to configure device encryption.
deleteOnTermination:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: Use to configure delete on termination of the associated device.
iops:
allOf:
- $ref: '#/components/schemas/EbsIopsInteger'
- description: Use to configure device IOPS.
kmsKeyId:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: Use to configure the KMS key to use when encrypting the device.
snapshotId:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The snapshot that defines the device contents.
volumeSize:
allOf:
- $ref: '#/components/schemas/EbsVolumeSizeInteger'
- description: Use to override the device's volume size.
volumeType:
allOf:
- $ref: '#/components/schemas/EbsVolumeType'
- description: Use to override the device's volume type.
throughput:
allOf:
- $ref: '#/components/schemas/EbsVolumeThroughput'
- description: '