ComponentSummary - EC2 Image Builder
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

ComponentSummary

A high-level summary of a component.

Contents

arn

The Amazon Resource Name (ARN) of the component.

Type: String

Pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):(?: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]+)?)?$

Required: No

changeDescription

The change description for the current version of the component.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

dateCreated

The original creation date of the component.

Type: String

Required: No

description

The description of the component.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

name

The name of the component.

Type: String

Pattern: ^[-_A-Za-z-0-9][-_A-Za-z0-9 ]{1,126}[-_A-Za-z-0-9]$

Required: No

obfuscate

Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.

Type: Boolean

Required: No

owner

The owner of the component.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

platform

The operating system platform of the component.

Type: String

Valid Values: Windows | Linux

Required: No

publisher

Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

state

Describes the current status of the component.

Type: ComponentState object

Required: No

supportedOsVersions

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.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Length Constraints: Minimum length of 1.

Required: No

tags

The tags that apply to the component.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Required: No

type

The component type specifies whether Image Builder uses the component to build the image or only to test it.

Type: String

Valid Values: BUILD | TEST

Required: No

version

The version of the component.

Type: String

Pattern: ^[0-9]+\.[0-9]+\.[0-9]+$

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: