imagebuilder / Client / create_image_recipe

create_image_recipe¶

imagebuilder.Client.create_image_recipe(**kwargs)¶

Creates a new image recipe. Image recipes define how images are configured, tested, and assessed.

Request Syntax

response = client.create_image_recipe(
    name='string',
    description='string',
    semanticVersion='string',
    components=[
        {
            'componentArn': 'string',
            'parameters': [
                {
                    'name': 'string',
                    'value': [
                        'string',
                    ]
                },
            ]
        },
    ],
    parentImage='string',
    blockDeviceMappings=[
        {
            'deviceName': 'string',
            'ebs': {
                'encrypted': True|False,
                'deleteOnTermination': True|False,
                'iops': 123,
                'kmsKeyId': 'string',
                'snapshotId': 'string',
                'volumeSize': 123,
                'volumeType': 'standard'|'io1'|'io2'|'gp2'|'gp3'|'sc1'|'st1',
                'throughput': 123
            },
            'virtualName': 'string',
            'noDevice': 'string'
        },
    ],
    tags={
        'string': 'string'
    },
    workingDirectory='string',
    additionalInstanceConfiguration={
        'systemsManagerAgent': {
            'uninstallAfterBuild': True|False
        },
        'userDataOverride': 'string'
    },
    amiTags={
        'string': 'string'
    },
    amiWatermarks=[
        'string',
    ],
    clientToken='string',
    dryRun=True|False
)

Parameters:

name (string) –
[REQUIRED]

The name of the image recipe. The recipe name, combined with the semantic version, must be unique to your account in each Amazon Web Services Region. Image Builder generates the image recipe ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name.
description (string) – The description of the image recipe.
semanticVersion (string) –
[REQUIRED]

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

Note
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. The upper limit is 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.
components (list) –
The components included in the image recipe. Components are optional. A recipe with no components bakes the base image without additional customization. You can specify each component only one time in a recipe. Components with a status of DEPRECATED or DISABLED can’t be added to new recipes.
- (dict) –
  
  Configuration details of the component. You can specify each component only once in a recipe, regardless of version. Components with a status of DEPRECATED or DISABLED can’t be added to new recipes.
  - componentArn (string) – [REQUIRED]
    
    The Amazon Resource Name (ARN) of the component. You can specify a build version ARN, or a component version ARN whose version segments can use x wildcards, for example 1.x.x.
  - parameters (list) –
    
    A group of parameter settings that Image Builder uses to configure the component for a specific recipe. You must supply a value for every component parameter that has no default value, and you can only supply parameters that the component defines.
    - (dict) –
      
      Contains a key/value pair that sets the named component parameter.
      - name (string) – [REQUIRED]
        
        The name of the component parameter to set.
      - value (list) – [REQUIRED]
        
        Sets the value for the named component parameter.
        
        (string) –
parentImage (string) –
[REQUIRED]

The base image for customizations specified in the image recipe. You can specify the parent image using one of the following options:
- AMI ID
- Image Builder image Amazon Resource Name (ARN)
- Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm:, followed by the parameter name or ARN.
- Amazon Web Services Marketplace product ID
If you enter an AMI ID or an SSM parameter that contains the AMI ID, you must have access to the AMI. The AMI must also be in the Region where you’re creating the recipe.
blockDeviceMappings (list) –
The block device mappings that Image Builder applies to the build instance and the output AMI. For example, you can override the size of the base image’s root volume or attach additional EBS volumes.
- (dict) –
  
  Defines block device mappings for the instance used to configure your image.
  - deviceName (string) –
    
    The device to which these mappings apply.
  - ebs (dict) –
    
    The Amazon EBS-specific configuration for this mapping.
    - encrypted (boolean) –
      
      Specifies whether to encrypt the device.
    - deleteOnTermination (boolean) –
      
      Specifies whether to delete the associated device on termination.
    - iops (integer) –
      
      The IOPS value for the device. Required only when volumeType is io1 or io2.
    - kmsKeyId (string) –
      
      The Amazon Resource Name (ARN) that uniquely identifies the KMS key to use when encrypting the device. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.
    - snapshotId (string) –
      
      The snapshot that defines the device contents.
    - volumeSize (integer) –
      
      Overrides the volume size for the device.
    - volumeType (string) –
      
      Overrides the volume type for the device.
    - throughput (integer) –
      
      For GP3 volumes only – The throughput in MiB/s that the volume supports.
  - virtualName (string) –
    
    The virtual device name for instance ephemeral devices.
  - noDevice (string) –
    
    Specifies a mapping to remove from the base image.
tags (dict) –
The tags of the image recipe.
- (string) –
  - (string) –
workingDirectory (string) – The working directory used during build and test workflows. If you don’t specify a working directory, Image Builder uses /tmp for Linux and macOS build instances, and C:/ for Windows build instances.
additionalInstanceConfiguration (dict) –
The additional settings and launch scripts for your build instances.
- systemsManagerAgent (dict) –
  
  The Systems Manager agent settings for your build instance. This setting applies to Linux and macOS build instances only. Requests that set it for a recipe with a Windows base image are rejected.
  - uninstallAfterBuild (boolean) –
    
    Specifies whether the Systems Manager agent is removed from your final build image before Image Builder creates the new AMI. If true, the agent is removed. If false, the agent is kept, so that it’s included in the AMI. If you don’t set this property, Image Builder removes the agent only if Image Builder installed the agent during the build. An agent that was pre-installed on the base image is kept.
- userDataOverride (string) –
  
  Use this property to provide commands or a command script to run when you launch your build instance.
  
  The userDataOverride property replaces any commands that Image Builder might have added to ensure that Systems Manager is installed on your Linux build instance. If you override the user data, make sure that you add commands to install Systems Manager, if it is not pre-installed on your base image.
  
  Note
  The user data is always base 64 encoded. For example, the following commands are encoded as IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhcg==:
  
  #!/bin/bash
  
  mkdir -p /var/bb/
  
  touch /var
amiTags (dict) –
Tags that are applied to the AMI that Image Builder creates during the Build phase prior to image distribution.
- (string) –
  - (string) –
amiWatermarks (list) –
The AMI watermark names to attach to the output AMI from this recipe. AMI watermarks are lineage markers. They automatically propagate to derivative AMIs when the source AMI is copied or distributed across Regions or accounts.

Note
AMI watermarks are supported only for image recipes. AMIs with watermarks cannot be made public.
- (string) –
  
  The name of an AMI watermark. AMI watermarks are lineage markers that Image Builder attaches to output AMIs during the build process. AMI watermarks automatically propagate to derivative AMIs when the source AMI is copied or distributed.
clientToken (string) –
[REQUIRED]

A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

This field is autopopulated if not provided.
dryRun (boolean) – Validates the required permissions and request parameters without performing the operation. If validation succeeds, the operation returns a DryRunOperationException error response.

Return type:

dict

Returns:

Response Syntax

{
    'requestId': 'string',
    'clientToken': 'string',
    'imageRecipeArn': 'string',
    'latestVersionReferences': {
        'latestVersionArn': 'string',
        'latestMajorVersionArn': 'string',
        'latestMinorVersionArn': 'string',
        'latestPatchVersionArn': 'string'
    }
}

Response Structure

(dict) –
- requestId (string) –
  
  The request ID that uniquely identifies this request.
- clientToken (string) –
  
  The client token that uniquely identifies the request.
- imageRecipeArn (string) –
  
  The Amazon Resource Name (ARN) of the image recipe that was created by this request.
- latestVersionReferences (dict) –
  
  A set of wildcard version ARNs that always reference the latest version of the resource. ARNs are included for the latest version overall, and for the latest versions within the same major, minor, and patch levels.
  - latestVersionArn (string) –
    
    The latest version Amazon Resource Name (ARN) of the Image Builder resource.
  - latestMajorVersionArn (string) –
    
    The latest version Amazon Resource Name (ARN) with the same major version of the Image Builder resource.
  - latestMinorVersionArn (string) –
    
    The latest version Amazon Resource Name (ARN) with the same minor version of the Image Builder resource.
  - latestPatchVersionArn (string) –
    
    The latest version Amazon Resource Name (ARN) with the same patch version of the Image Builder resource.

Exceptions

imagebuilder.Client.exceptions.ServiceException
imagebuilder.Client.exceptions.ClientException
imagebuilder.Client.exceptions.ServiceUnavailableException
imagebuilder.Client.exceptions.InvalidRequestException
imagebuilder.Client.exceptions.IdempotentParameterMismatchException
imagebuilder.Client.exceptions.ForbiddenException
imagebuilder.Client.exceptions.CallRateLimitExceededException
imagebuilder.Client.exceptions.InvalidVersionNumberException
imagebuilder.Client.exceptions.ResourceInUseException
imagebuilder.Client.exceptions.ResourceAlreadyExistsException
imagebuilder.Client.exceptions.ServiceQuotaExceededException
imagebuilder.Client.exceptions.DryRunOperationException