interface IComponent 🔹

Language	Type name
.NET	Amazon.CDK.AWS.ImageBuilder.Alpha.IComponent
Go	github.com/aws/aws-cdk-go/awsimagebuilderalpha/v2#IComponent
Java	software.amazon.awscdk.services.imagebuilder.alpha.IComponent
Python	aws_cdk.aws_imagebuilder_alpha.IComponent
TypeScript (source)	@aws-cdk/aws-imagebuilder-alpha » IComponent

Implemented by Component

Obtainable from AwsManagedComponent.awsCliV2(), AwsManagedComponent.fromAwsManagedComponentAttributes(), AwsManagedComponent.fromAwsManagedComponentName(), AwsManagedComponent.helloWorld(), AwsManagedComponent.python3(), AwsManagedComponent.reboot(), AwsManagedComponent.stigBuild(), AwsManagedComponent.updateOS(), AwsMarketplaceComponent.fromAwsMarketplaceComponentAttributes(), Component.fromComponentArn(), Component.fromComponentAttributes(), Component.fromComponentName()

An EC2 Image Builder Component.

Properties

Name	Type	Description
componentArn🔹	string	The ARN of the component.
componentName🔹	string	The name of the component.
componentVersion🔹	string	The version of the component.
env🔹	ResourceEnvironment	The environment this resource belongs to.
node🔹	Node	The tree node.
stack🔹	Stack	The stack in which this resource is defined.

---

componentArn🔹

Type: string

The ARN of the component.

---

componentName🔹

Type: string

The name of the component.

---

componentVersion🔹

Type: string

The version of the component.

---

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

node🔹

Type: Node

The tree node.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
grant(grantee, ...actions)🔹	Grant custom actions to the given grantee for the component.
grantRead(grantee)🔹	Grant read permissions to the given grantee for the component.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

grant(grantee, ...actions)🔹

public grant(grantee: IGrantable, ...actions: string[]): Grant

Parameters

• grantee IGrantable — The principal.
• actions string — The list of actions.

Returns

• Grant

Grant custom actions to the given grantee for the component.

---

grantRead(grantee)🔹

public grantRead(grantee: IGrantable): Grant

Parameters

• grantee IGrantable — The principal.

Returns

• Grant

Grant read permissions to the given grantee for the component.