imagebuilder / Client / create_container_recipe

create_container_recipe¶

imagebuilder.Client.create_container_recipe(**kwargs)¶

Creates a new container recipe. Container recipes define how images are configured, tested, and assessed.

Request Syntax

response = client.create_container_recipe(
    containerType='DOCKER',
    name='string',
    description='string',
    semanticVersion='string',
    components=[
        {
            'componentArn': 'string',
            'parameters': [
                {
                    'name': 'string',
                    'value': [
                        'string',
                    ]
                },
            ]
        },
    ],
    instanceConfiguration={
        'image': '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'
            },
        ]
    },
    dockerfileTemplateData='string',
    dockerfileTemplateUri='string',
    platformOverride='Windows'|'Linux'|'macOS',
    imageOsVersionOverride='string',
    parentImage='string',
    tags={
        'string': 'string'
    },
    workingDirectory='string',
    targetRepository={
        'service': 'ECR',
        'repositoryName': 'string'
    },
    kmsKeyId='string',
    clientToken='string',
    dryRun=True|False
)

Parameters:

containerType (string) –
[REQUIRED]

The type of container to create.
name (string) –
[REQUIRED]

The name of the container 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 container 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 container recipe.
semanticVersion (string) –
[REQUIRED]

The semantic version of the container 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 container recipe. You can specify each component only one time in a recipe.
- (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) –
instanceConfiguration (dict) –
A group of options that can be used to configure an instance for building and testing container images.
- image (string) –
  
  The base image for a container build and test instance. This can contain an AMI ID or it can specify an Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm:, followed by the parameter name or ARN.
  
  If not specified, Image Builder uses the appropriate ECS-optimized AMI as a base image.
- blockDeviceMappings (list) –
  
  Defines the block device mappings for the EC2 instance that Image Builder launches to build and test your container image.
  - (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.
dockerfileTemplateData (string) – The Dockerfile template used to build your image, as an inline data blob. You must specify exactly one of the dockerfileTemplateData or dockerfileTemplateUri properties. For the contextual variables that the template can include, see Create a new version of a container recipe in the EC2 Image Builder User Guide.
dockerfileTemplateUri (string) – The Amazon S3 URI for the Dockerfile template that is used to build your container image. You must have permission to read the object. Image Builder reads the object once, when it creates the recipe, and stores its content in the recipe. Later changes to the S3 object don’t affect the recipe. You must specify exactly one of the dockerfileTemplateData or dockerfileTemplateUri properties.
platformOverride (string) – Specifies the operating system platform when you use a custom base image. Container recipes support only the Linux and Windows platforms.
imageOsVersionOverride (string) – Specifies the operating system version for the base image. Use this property only when the base image is a container image from a registry. When the base image is an Image Builder image, the operating system version comes from the parent image.
parentImage (string) –
[REQUIRED]

The base image for the container recipe. This can be an Image Builder image resource ARN or a container image URI from a registry, for example amazonlinux:latest.
tags (dict) –
Tags that are attached to the container recipe.
- (string) –
  - (string) –
workingDirectory (string) – The working directory for use during build and test workflows.
targetRepository (dict) –
[REQUIRED]

The destination repository for the container image. The Amazon ECR repository must already exist in the Amazon Web Services Region where the build runs.
- service (string) – [REQUIRED]
  
  Specifies the service in which this image was registered.
- repositoryName (string) – [REQUIRED]
  
  The name of the container repository where the output container image is stored. Provide the repository name only (a namespace path such as team-a/my-repo is allowed, but not the registry hostname).
kmsKeyId (string) – The Amazon Resource Name (ARN) that uniquely identifies which KMS key is used to encrypt the Dockerfile template. 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.
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',
    'containerRecipeArn': '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.
- containerRecipeArn (string) –
  
  Returns the Amazon Resource Name (ARN) of the container recipe that the request created.
- 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