:doc:`imagebuilder <../../imagebuilder>` / Client / create_container_recipe

***********************
create_container_recipe
***********************



.. py:method:: imagebuilder.Client.create_container_recipe(**kwargs)

  

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

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateContainerRecipe>`_  


  **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'
    )
    
  :type containerType: string
  :param containerType: **[REQUIRED]** 

    The type of container to create.

    

  
  :type name: string
  :param name: **[REQUIRED]** 

    The name of the container recipe.

    

  
  :type description: string
  :param description: 

    The description of the container recipe.

    

  
  :type semanticVersion: string
  :param semanticVersion: **[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, 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 components: list
  :param components: 

    The components included in the container recipe.

    

  
    - *(dict) --* 

      Configuration details of the component.

      

    
      - **componentArn** *(string) --* **[REQUIRED]** 

        The Amazon Resource Name (ARN) of the component.

        

      
      - **parameters** *(list) --* 

        A group of parameter settings that Image Builder uses to configure the component for a specific recipe.

        

      
        - *(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) --* 

            
        
        
    
    

  :type instanceConfiguration: dict
  :param instanceConfiguration: 

    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 devices to attach for building an instance from this Image Builder AMI.

      

    
      - *(dict) --* 

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

        

      
        - **deviceName** *(string) --* 

          The device to which these mappings apply.

          

        
        - **ebs** *(dict) --* 

          Use to manage Amazon EBS-specific configuration for this mapping.

          

        
          - **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) --* 

            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) <https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN>`__ in the *Key Management Service Developer Guide*.

            

          
          - **snapshotId** *(string) --* 

            The snapshot that defines the device contents.

            

          
          - **volumeSize** *(integer) --* 

            Use to override the device's volume size.

            

          
          - **volumeType** *(string) --* 

            Use to override the device's volume type.

            

          
          - **throughput** *(integer) --* 

            **For GP3 volumes only** – The throughput in MiB/s that the volume supports.

            

          
        
        - **virtualName** *(string) --* 

          Use to manage instance ephemeral devices.

          

        
        - **noDevice** *(string) --* 

          Use to remove a mapping from the base image.

          

        
      
  
  
  :type dockerfileTemplateData: string
  :param dockerfileTemplateData: 

    The Dockerfile template used to build your image as an inline data blob.

    

  
  :type dockerfileTemplateUri: string
  :param dockerfileTemplateUri: 

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

    

  
  :type platformOverride: string
  :param platformOverride: 

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

    

  
  :type imageOsVersionOverride: string
  :param imageOsVersionOverride: 

    Specifies the operating system version for the base image.

    

  
  :type parentImage: string
  :param parentImage: **[REQUIRED]** 

    The base image for the container recipe.

    

  
  :type tags: dict
  :param tags: 

    Tags that are attached to the container recipe.

    

  
    - *(string) --* 

    
      - *(string) --* 

      


  :type workingDirectory: string
  :param workingDirectory: 

    The working directory for use during build and test workflows.

    

  
  :type targetRepository: dict
  :param targetRepository: **[REQUIRED]** 

    The destination repository for the container image.

    

  
    - **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. This name is prefixed by the repository location. For example, ``<repository location url>/repository_name``.

      

    
  
  :type kmsKeyId: string
  :param kmsKeyId: 

    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) <https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN>`__ in the *Key Management Service Developer Guide*.

    

  
  :type clientToken: string
  :param clientToken: **[REQUIRED]** 

    Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see `Ensuring idempotency <https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html>`__ in the *Amazon EC2 API Reference*.

    This field is autopopulated if not provided.

  
  
  :rtype: 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) --* 

        The resource ARNs with different wildcard variations of semantic versioning.

        
        

        - **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**
  
  *   :py:class:`imagebuilder.Client.exceptions.ServiceException`

  
  *   :py:class:`imagebuilder.Client.exceptions.ClientException`

  
  *   :py:class:`imagebuilder.Client.exceptions.ServiceUnavailableException`

  
  *   :py:class:`imagebuilder.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`imagebuilder.Client.exceptions.IdempotentParameterMismatchException`

  
  *   :py:class:`imagebuilder.Client.exceptions.ForbiddenException`

  
  *   :py:class:`imagebuilder.Client.exceptions.CallRateLimitExceededException`

  
  *   :py:class:`imagebuilder.Client.exceptions.InvalidVersionNumberException`

  
  *   :py:class:`imagebuilder.Client.exceptions.ResourceInUseException`

  
  *   :py:class:`imagebuilder.Client.exceptions.ResourceAlreadyExistsException`

  
  *   :py:class:`imagebuilder.Client.exceptions.ServiceQuotaExceededException`

  