Skip to content
AWS for Query.Farm

aws.imagebuilder.get_container_recipe

Example SQL Queries

SELECT * FROM
aws.imagebuilder.get_container_recipe
WHERE
"container_recipe_arn" = 'VALUE';

Description

Retrieves a container recipe.

Table Definition

Column NameColumn Data Type
container_recipe_arn Required Input Column

The Amazon Resource Name (ARN) of the container recipe 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.

container_recipe

The container recipe object that is returned.

STRUCT(
    "arn" VARCHAR,
    "container_type" VARCHAR,
    "name" VARCHAR,
    "description" VARCHAR,
    "platform" VARCHAR,
    "owner" VARCHAR,
    "version" VARCHAR,
    "components" STRUCT(
        "component_arn" VARCHAR,
        "parameters" STRUCT(
            "name" VARCHAR,
            "value" VARCHAR[]
        )[]
    )[],
    "instance_configuration" STRUCT(
        "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
        )[]
    ),
    "dockerfile_template_data" VARCHAR,
    "kms_key_id" VARCHAR,
    "encrypted" BOOLEAN,
    "parent_image" VARCHAR,
    "date_created" VARCHAR,
    "tags" MAP(VARCHAR, VARCHAR),
    "working_directory" VARCHAR,
    "target_repository" STRUCT(
        "service" VARCHAR,
        "repository_name" VARCHAR
    )
)
Show child fields
container_recipe.arn

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.

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

The Amazon Resource Name (ARN) of the component.

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

The name of the component parameter to set.

container_recipe.components[].parameters[].value[]
container_recipe.container_type

Specifies the type of container, such as Docker.

container_recipe.date_created

The date when this container recipe was created.

container_recipe.description

The description of the container recipe.

container_recipe.dockerfile_template_data

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.

container_recipe.encrypted

A flag that indicates if the target container is encrypted.

container_recipe.instance_configuration

A group of options that can be used to configure an instance for building and testing container images.

Show child fields
container_recipe.instance_configuration.block_device_mappings[]
Show child fields
container_recipe.instance_configuration.block_device_mappings[].device_name

The device to which these mappings apply.

container_recipe.instance_configuration.block_device_mappings[].ebs

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

Show child fields
container_recipe.instance_configuration.block_device_mappings[].ebs.delete_on_termination

Use to configure delete on termination of the associated device.

container_recipe.instance_configuration.block_device_mappings[].ebs.encrypted

Use to configure device encryption.

container_recipe.instance_configuration.block_device_mappings[].ebs.iops

Use to configure device IOPS.

container_recipe.instance_configuration.block_device_mappings[].ebs.kms_key_id

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

container_recipe.instance_configuration.block_device_mappings[].ebs.snapshot_id

The snapshot that defines the device contents.

container_recipe.instance_configuration.block_device_mappings[].ebs.throughput

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

container_recipe.instance_configuration.block_device_mappings[].ebs.volume_size

Use to override the device's volume size.

container_recipe.instance_configuration.block_device_mappings[].ebs.volume_type

Use to override the device's volume type.

container_recipe.instance_configuration.block_device_mappings[].no_device

Use to remove a mapping from the base image.

container_recipe.instance_configuration.block_device_mappings[].virtual_name

Use to manage instance ephemeral devices.

container_recipe.instance_configuration.image

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.

container_recipe.kms_key_id

Identifies which KMS key is used to encrypt the container image for distribution to the target Region.

container_recipe.name

The name of the container recipe.

container_recipe.owner

The owner of the container recipe.

container_recipe.parent_image

The base image for the container recipe.

container_recipe.platform

The system platform for the container, such as Windows or Linux.

container_recipe.tags

Tags that are attached to the container recipe.

container_recipe.target_repository

The destination repository for the container image.

Show child fields
container_recipe.target_repository.repository_name

The name of the container repository where the output container image is stored. This name is prefixed by the repository location.

container_recipe.target_repository.service

Specifies the service in which this image was registered.

container_recipe.version

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.

container_recipe.working_directory

The working directory for use during build and test workflows.

request_id

The request ID that uniquely identifies this request.

VARCHAR