container_recipe

Gets an individual container_recipe resource

Overview

Name	container_recipe
Type	Resource
Description	container_recipe
Id	awscc.imagebuilder.container_recipe

Fields

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the container recipe.
name	string	The name of the container recipe.
description	string	The description of the container recipe.
version	string	The semantic version of the container recipe (<major>.<minor>.<patch>).
components	array	Components for build and test that are included in the container recipe.
instance_configuration	object	A group of options that can be used to configure an instance for building and testing container images.
dockerfile_template_data	string	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.
dockerfile_template_uri	string	The S3 URI for the Dockerfile that will be used to build your container image.
platform_override	string	Specifies the operating system platform when you use a custom source image.
container_type	string	Specifies the type of container, such as Docker.
image_os_version_override	string	Specifies the operating system version for the source image.
target_repository	object	The destination repository for the container image.
kms_key_id	string	Identifies which KMS key is used to encrypt the container image.
parent_image	string	The source image for the container recipe.
working_directory	string	The working directory to be used during build and test workflows.
tags	object	Tags that are attached to the container recipe.
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
arn,
name,
description,
version,
components,
instance_configuration,
dockerfile_template_data,
dockerfile_template_uri,
platform_override,
container_type,
image_os_version_override,
target_repository,
kms_key_id,
parent_image,
working_directory,
tags
FROM awscc.imagebuilder.container_recipe
WHERE data__Identifier = '<Arn>';

Permissions

To operate on the container_recipe resource, the following permissions are required:

Read

imagebuilder:GetContainerRecipe

Delete

imagebuilder:UnTagResource,
imagebuilder:GetContainerRecipe,
imagebuilder:DeleteContainerRecipe