Package software.amazon.awscdk.services.imagebuilder.alpha

Interface AwsManagedComponentAttributes

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AwsManagedComponentAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-20T23:37:34.436Z")
@Stability(Experimental)
public interface AwsManagedComponentAttributes
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for an EC2 Image Builder AWS-managed component.

Example:

 // Install AWS CLI v2
 IComponent awsCliComponent = AwsManagedComponent.awsCliV2(this, "AwsCli", AwsManagedComponentAttributes.builder()
         .platform(Platform.LINUX)
         .build());
 // Update the operating system
 IComponent updateComponent = AwsManagedComponent.updateOS(this, "UpdateOS", AwsManagedComponentAttributes.builder()
         .platform(Platform.LINUX)
         .build());
 // Reference any AWS-managed component by name
 IComponent customAwsComponent = AwsManagedComponent.fromAwsManagedComponentName(this, "CloudWatchAgent", "amazon-cloudwatch-agent-linux");
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	AwsManagedComponentAttributes.Builder	A builder for AwsManagedComponentAttributes
static final class	AwsManagedComponentAttributes.Jsii$Proxy	An implementation for AwsManagedComponentAttributes

Method Summary

Modifier and Type	Method	Description
static AwsManagedComponentAttributes.Builder	builder()
default String	getComponentName()	(experimental) The name of the AWS-managed component.
default String	getComponentVersion()	(experimental) The version of the AWS-managed component.
default Platform	getPlatform()	(experimental) The platform of the AWS-managed component.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getComponentName

@Stability(Experimental)
@Nullable
default String getComponentName()

(experimental) The name of the AWS-managed component.

The name of the AWS-managed component. This is a required attribute when using the this.fromAwsManagedComponentAttributes() method. This parameter should not be provided when using the pre-defined managed component methods, such as AwsManagedComponent.updateOS() and AwsManagedComponent.reboot().

Default: - none if using the pre-defined managed component methods, otherwise a platform is required when using `this.fromAwsManagedComponentAttributes()`

getComponentVersion

@Stability(Experimental)
@Nullable
default String getComponentVersion()

(experimental) The version of the AWS-managed component.

Default: - the latest version of the component, x.x.x

getPlatform

@Stability(Experimental)
@Nullable
default Platform getPlatform()

(experimental) The platform of the AWS-managed component.

This is a required attribute when using the pre-defined managed component methods, such as AwsManagedComponent.updateOS() and AwsManagedComponent.reboot(). This parameter should not be provided when using the this.fromAwsManagedComponentAttributes() method.

Default: - none if using `this.fromAwsManagedComponentAttributes()`, otherwise a platform is required when using the pre-defined managed component methods

builder

@Stability(Experimental)
static AwsManagedComponentAttributes.Builder builder()

Returns:

a AwsManagedComponentAttributes.Builder of AwsManagedComponentAttributes