AWS::ImageBuilder::Component

ImageBuilder Component

Resource schema for AWS::ImageBuilder::Component

Properties

10 configurable properties. 3 required. Click a row to see details.

Filter:

Property	Type	Flags
`Name`	`string`	RequiredCreate-only
`Platform`	`string`	RequiredCreate-only
`Version`	`string`	RequiredCreate-only
`ChangeDescription`	`string`	Create-only
`Data`	`string`	Create-onlyWrite-only
`Description`	`string`	Create-only
`KmsKeyId`	`string`	Create-only
`SupportedOsVersions`	`Array<string>`	Create-only
`Tags`	`object`
`Uri`	`string`	Create-onlyWrite-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`Arn`	`string`	The Amazon Resource Name (ARN) of the component.
`Encrypted`	`boolean`	The encryption status of the component.
`LatestVersion`	`LatestVersion`	The latest version references of the component.
`Type`	`string`	The type of the component denotes whether the component is used to build the image or only to test it.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::ImageBuilder::Component

Resources:
  MyResource:
    Type: AWS::ImageBuilder::Component
    Properties:
      Name: "my-name"
      Platform: "Windows"
      Version: "value"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

iam:CreateServiceLinkedRoleiam:GetRolekms:GenerateDataKeykms:GenerateDataKeyPairkms:GenerateDataKeyPairWithoutPlaintextkms:GenerateDataKeyWithoutPlaintextkms:Encryptkms:Decrypt

update

imagebuilder:TagResourceimagebuilder:UntagResource

read

imagebuilder:GetComponentkms:Decrypt

delete

imagebuilder:GetComponentimagebuilder:UntagResourceimagebuilder:DeleteComponent

list

imagebuilder:ListComponentsimagebuilder:ListComponentBuildVersions

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceImageBuilder

Properties14

Required3

TaggingSupported

Primary IDArn

Supported Operations

CreateUpdateReadDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

NameVersionChangeDescriptionDescriptionPlatformDataUriKmsKeyIdSupportedOsVersions

Related Resources

External Links

AWS Documentation