Component - EC2 Image Builder

Component

A detailed view of a component.

Contents

arn

The Amazon Resource Name (ARN) of the component.

Type: String

Pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:\d{12}|aws):(?:image-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline)/[a-z0-9-_]+(?:/(?:(?:x|\d+)\.(?:x|\d+)\.(?:x|\d+))(?:/\d+)?)?$

Required: No

changeDescription

The change description of the component.

Type: String

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

Required: No

data

The data of the component.

Type: String

Required: No

dateCreated

The date that the component was created.

Type: String

Required: No

description

The description of the component.

Type: String

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

Required: No

encrypted

The encryption status of the component.

Type: Boolean

Required: No

kmsKeyId

The KMS key identifier used to encrypt 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

owner

The owner of the component.

Type: String

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

Required: No

platform

The platform of the component.

Type: String

Valid Values: Windows | Linux

Required: No

tags

The tags associated with the component.

Type: String to string map

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 type of the component denotes whether the component is used 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 AWS SDKs, see the following: