aws_imagebuilder_image_recipe

account_id

Type: STRING

image_recipe

Type: STRUCT
Provider name: imageRecipe
Description: The image recipe object.

• additional_instance_configuration
  Type: STRUCT
  Provider name: additionalInstanceConfiguration
  Description: Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration. Instance configuration adds a layer of control over those instances. You can define settings and add scripts to run when an instance is launched from your AMI.
  
  • systems_manager_agent
    Type: STRUCT
    Provider name: systemsManagerAgent
    Description: Contains settings for the Systems Manager agent on your build instance.
    
    • uninstall_after_build
      Type: BOOLEAN
      Provider name: uninstallAfterBuild
      Description: Controls whether the Systems Manager agent is removed from your final build image, prior to creating the new AMI. If this is set to true, then the agent is removed from the final image. If it’s set to false, then the agent is left in, so that it is included in the new AMI. The default value is false.
      
  • user_data_override
    Type: STRING
    Provider name: userDataOverride
    Description: 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. The user data is always base 64 encoded. For example, the following commands are encoded as IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$: #!/bin/bash mkdir -p /var/bb/ touch /var
    
• arn
  Type: STRING
  Provider name: arn
  Description: The Amazon Resource Name (ARN) of the image recipe.
  
• block_device_mappings
  Type: UNORDERED_LIST_STRUCT
  Provider name: blockDeviceMappings
  Description: The block device mappings to apply when creating images from this recipe.
  
  • 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.
    
• components
  Type: UNORDERED_LIST_STRUCT
  Provider name: components
  Description: The components that are included in the image 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.
      
• date_created
  Type: STRING
  Provider name: dateCreated
  Description: The date on which this image recipe was created.
  
• description
  Type: STRING
  Provider name: description
  Description: The description of the image recipe.
  
• name
  Type: STRING
  Provider name: name
  Description: The name of the image recipe.
  
• owner
  Type: STRING
  Provider name: owner
  Description: The owner of the image recipe.
  
• parent_image
  Type: STRING
  Provider name: parentImage
  Description: The base image of the image recipe.
  
• platform
  Type: STRING
  Provider name: platform
  Description: The platform of the image recipe.
  
• type
  Type: STRING
  Provider name: type
  Description: Specifies which type of image is created by the recipe - an AMI or a container image.
  
• version
  Type: STRING
  Provider name: version
  Description: The version of the image recipe.
  
• working_directory
  Type: STRING
  Provider name: workingDirectory
  Description: The working directory to be used 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