component_build_versions

Creates, updates, deletes, gets or lists a component_build_versions resource.

Overview

Name	component_build_versions
Type	Resource
Id	aws.imagebuilder.component_build_versions

Fields

The following fields are returned by SELECT queries:

list_component_build_versions

Name	Datatype	Description
name	string	The name of the component. (pattern: <code>^[-_A-Za-z-0-9][-_A-Za-z0-9 ]{1,126}[-_A-Za-z-0-9]$</code>)
arn	string	The Amazon Resource Name (ARN) of the component. (pattern: <code>^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+).(?:x|[0-9]+).(?:x|[0-9]+))(?:/[0-9]+)?)?$</code>)
change_description	string	The change description for the current version of the component.
date_created	string	The original creation date of the component.
description	string	The description of the component.
obfuscate	boolean	Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.
owner	string	The owner of the component.
platform	string	The operating system platform of the component. (Windows, Linux, macOS)
publisher	string	Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.
state	object	Describes the current status of the component.
supported_os_versions	array	The operating system (OS) version that the component supports. If the OS information is available, Image Builder performs a prefix match against the base image OS version during image recipe creation.
tags	object	The tags that apply to the component.
type_	string	The component type specifies whether Image Builder uses the component to build the image or only to test it. (BUILD, TEST)
version	string	The version of the component. (pattern: <code>^[0-9]+.[0-9]+.[0-9]+$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_component_build_versions	select	region		Returns the list of component build versions for the specified component version Amazon Resource Name (ARN).

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_component_build_versions

Returns the list of component build versions for the specified component version Amazon Resource Name (ARN).

SELECT
name,
arn,
change_description,
date_created,
description,
obfuscate,
owner,
platform,
publisher,
state,
supported_os_versions,
tags,
type_,
version
FROM aws.imagebuilder.component_build_versions
WHERE region = '{{ region }}' -- required
;