Skip to content
AWS for Query.Farm

aws.imagebuilder.get_image_recipe

Example SQL Queries

SELECT * FROM
aws.imagebuilder.get_image_recipe
WHERE
"image_recipe_arn" = 'VALUE';

Description

Gets an image recipe.

Table Definition

Column NameColumn Data Type
image_recipe_arn Required Input Column

The Amazon Resource Name (ARN) of the image recipe that you want to retrieve.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

image_recipe

The image recipe object.

STRUCT(
    "arn" VARCHAR,
    "type" VARCHAR,
    "name" VARCHAR,
    "description" VARCHAR,
    "platform" VARCHAR,
    "owner" VARCHAR,
    "version" VARCHAR,
    "components" STRUCT(
        "component_arn" VARCHAR,
        "parameters" STRUCT(
            "name" VARCHAR,
            "value" VARCHAR[]
        )[]
    )[],
    "parent_image" VARCHAR,
    "block_device_mappings" STRUCT(
        "device_name" VARCHAR,
        "ebs" STRUCT(
            "encrypted" BOOLEAN,
            "delete_on_termination" BOOLEAN,
            "iops" BIGINT,
            "kms_key_id" VARCHAR,
            "snapshot_id" VARCHAR,
            "volume_size" BIGINT,
            "volume_type" VARCHAR,
            "throughput" BIGINT
        ),
        "virtual_name" VARCHAR,
        "no_device" VARCHAR
    )[],
    "date_created" VARCHAR,
    "tags" MAP(VARCHAR, VARCHAR),
    "working_directory" VARCHAR,
    "additional_instance_configuration" STRUCT(
        "systems_manager_agent" STRUCT(
            "uninstall_after_build" BOOLEAN
        ),
        "user_data_override" VARCHAR
    )
)
Show child fields
image_recipe.additional_instance_configuration

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.

Show child fields
image_recipe.additional_instance_configuration.systems_manager_agent

Contains settings for the Systems Manager agent on your build instance.

Show child fields
image_recipe.additional_instance_configuration.systems_manager_agent.uninstall_after_build

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.

image_recipe.additional_instance_configuration.user_data_override

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

image_recipe.arn

The Amazon Resource Name (ARN) of the image recipe.

image_recipe.block_device_mappings[]
Show child fields
image_recipe.block_device_mappings[].device_name

The device to which these mappings apply.

image_recipe.block_device_mappings[].ebs

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

Show child fields
image_recipe.block_device_mappings[].ebs.delete_on_termination

Use to configure delete on termination of the associated device.

image_recipe.block_device_mappings[].ebs.encrypted

Use to configure device encryption.

image_recipe.block_device_mappings[].ebs.iops

Use to configure device IOPS.

image_recipe.block_device_mappings[].ebs.kms_key_id

Use to configure the KMS key to use when encrypting the device.

image_recipe.block_device_mappings[].ebs.snapshot_id

The snapshot that defines the device contents.

image_recipe.block_device_mappings[].ebs.throughput

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

image_recipe.block_device_mappings[].ebs.volume_size

Use to override the device's volume size.

image_recipe.block_device_mappings[].ebs.volume_type

Use to override the device's volume type.

image_recipe.block_device_mappings[].no_device

Use to remove a mapping from the base image.

image_recipe.block_device_mappings[].virtual_name

Use to manage instance ephemeral devices.

image_recipe.components[]
Show child fields
image_recipe.components[].component_arn

The Amazon Resource Name (ARN) of the component.

image_recipe.components[].parameters[]
Show child fields
image_recipe.components[].parameters[].name

The name of the component parameter to set.

image_recipe.components[].parameters[].value[]
image_recipe.date_created

The date on which this image recipe was created.

image_recipe.description

The description of the image recipe.

image_recipe.name

The name of the image recipe.

image_recipe.owner

The owner of the image recipe.

image_recipe.parent_image

The base image of the image recipe.

image_recipe.platform

The platform of the image recipe.

image_recipe.tags

The tags of the image recipe.

image_recipe.type

Specifies which type of image is created by the recipe - an AMI or a container image.

image_recipe.version

The version of the image recipe.

image_recipe.working_directory

The working directory to be used during build and test workflows.

request_id

The request ID that uniquely identifies this request.

VARCHAR