aws_imagebuilder_public_container_recipe

account_id

Type: STRING

container_recipe

Type: STRUCT
Provider name: containerRecipe
Description: The container recipe object that is returned.

• arn
  Type: STRING
  Provider name: arn
  Description: The Amazon Resource Name (ARN) of the container recipe. Semantic versioning is included in each object’s Amazon Resource Name (ARN), at the level that applies to that object as follows:
  1. Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
  2. Version ARNs have only the first three nodes: <major>.<minor>.<patch>
  3. Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
  
  
• components
  Type: UNORDERED_LIST_STRUCT
  Provider name: components
  Description: Build and test components 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.
  
  • component_arn
    Type: STRING
    Provider name: componentArn
    Description: The Amazon Resource Name (ARN) of the component.
    
  • parameters
    Type: UNORDERED_LIST_STRUCT
    Provider name: parameters
    Description: A group of parameter settings that Image Builder uses to configure the component for a specific recipe.
    
    • name
      Type: STRING
      Provider name: name
      Description: The name of the component parameter to set.
      
    • value
      Type: UNORDERED_LIST_STRING
      Provider name: value
      Description: Sets the value for the named component parameter.
      
• container_type
  Type: STRING
  Provider name: containerType
  Description: Specifies the type of container, such as Docker.
  
• date_created
  Type: STRING
  Provider name: dateCreated
  Description: The date when this container recipe was created.
  
• description
  Type: STRING
  Provider name: description
  Description: The description of the container recipe.
  
• dockerfile_template_data
  Type: STRING
  Provider name: dockerfileTemplateData
  Description: 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.
  
• encrypted
  Type: BOOLEAN
  Provider name: encrypted
  Description: A flag that indicates if the target container is encrypted.
  
• instance_configuration
  Type: STRUCT
  Provider name: instanceConfiguration
  Description: A group of options that can be used to configure an instance for building and testing container images.
  
  • block_device_mappings
    Type: UNORDERED_LIST_STRUCT
    Provider name: blockDeviceMappings
    Description: Defines the block devices to attach for building an instance from this Image Builder AMI.
    
    • device_name
      Type: STRING
      Provider name: deviceName
      Description: The device to which these mappings apply.
      
    • ebs
      Type: STRUCT
      Provider name: ebs
      Description: Use to manage Amazon EBS-specific configuration for this mapping.
      
      • delete_on_termination
        Type: BOOLEAN
        Provider name: deleteOnTermination
        Description: Use to configure delete on termination of the associated device.
        
      • encrypted
        Type: BOOLEAN
        Provider name: encrypted
        Description: Use to configure device encryption.
        
      • iops
        Type: INT32
        Provider name: iops
        Description: Use to configure device IOPS.
        
      • kms_key_id
        Type: STRING
        Provider name: kmsKeyId
        Description: Use to configure the KMS key to use when encrypting the device.
        
      • snapshot_id
        Type: STRING
        Provider name: snapshotId
        Description: The snapshot that defines the device contents.
        
      • throughput
        Type: INT32
        Provider name: throughput
        Description: For GP3 volumes only – The throughput in MiB/s that the volume supports.
        
      • volume_size
        Type: INT32
        Provider name: volumeSize
        Description: Use to override the device’s volume size.
        
      • volume_type
        Type: STRING
        Provider name: volumeType
        Description: Use to override the device’s volume type.
        
    • no_device
      Type: STRING
      Provider name: noDevice
      Description: Use to remove a mapping from the base image.
      
    • virtual_name
      Type: STRING
      Provider name: virtualName
      Description: Use to manage instance ephemeral devices.
      
  • image
    Type: STRING
    Provider name: image
    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.
    
• kms_key_id
  Type: STRING
  Provider name: kmsKeyId
  Description: Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
  
• name
  Type: STRING
  Provider name: name
  Description: The name of the container recipe.
  
• owner
  Type: STRING
  Provider name: owner
  Description: The owner of the container recipe.
  
• parent_image
  Type: STRING
  Provider name: parentImage
  Description: The base image for the container recipe.
  
• platform
  Type: STRING
  Provider name: platform
  Description: The system platform for the container, such as Windows or Linux.
  
• target_repository
  Type: STRUCT
  Provider name: targetRepository
  Description: The destination repository for the container image.
  
  • repository_name
    Type: STRING
    Provider name: repositoryName
    Description: 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.
    
  • service
    Type: STRING
    Provider name: service
    Description: Specifies the service in which this image was registered.
    
• version
  Type: STRING
  Provider name: version
  Description: The semantic version of the container recipe. 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. Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
  
• working_directory
  Type: STRING
  Provider name: workingDirectory
  Description: The working directory for use during build and test workflows.
  

request_id

Type: STRING
Provider name: requestId
Description: The request ID that uniquely identifies this request.

tags

Type: UNORDERED_LIST_STRING