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

Interface ComponentProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ComponentProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-20T23:37:34.454Z") @Stability(Experimental) public interface ComponentProps extends software.amazon.jsii.JsiiSerializable
(experimental) Properties for creating a Component resource.

Example: 

 Component component = Component.Builder.create(this, "MyComponent")
         .platform(Platform.LINUX)
         .data(ComponentData.fromJsonObject(Map.of(
                 "schemaVersion", ComponentSchemaVersion.V1_0,
                 "phases", List.of(Map.of(
                         "name", ComponentPhaseName.BUILD,
                         "steps", List.of(Map.of(
                                 "name", "install-app",
                                 "action", ComponentAction.EXECUTE_BASH,
                                 "inputs", Map.of(
                                         "commands", List.of("echo \"Installing my application...\"", "yum update -y")))))))))
         .build();

  • Method Details

    • getData

      @Stability(Experimental) @NotNull ComponentData getData()
      (experimental) The component document content that defines the build, validation, or test steps to be executed during the image building process.

    • getPlatform

      @Stability(Experimental) @NotNull Platform getPlatform()
      (experimental) The operating system platform of the component.

    • getChangeDescription

      @Stability(Experimental) @Nullable default String getChangeDescription()
      (experimental) The change description of the component.

      Describes what change has been made in this version of the component, or what makes this version different from other versions.

      Default: None

    • getComponentName

      @Stability(Experimental) @Nullable default String getComponentName()
      (experimental) The name of the component.

      Default: - a name is generated

    • getComponentVersion

      @Stability(Experimental) @Nullable default String getComponentVersion()
      (experimental) The version of the component.

      Default: 1.0.0

    • getDescription

      @Stability(Experimental) @Nullable default String getDescription()
      (experimental) The description of the component.

      Default: None

    • getKmsKey

      @Stability(Experimental) @Nullable default IKey getKmsKey()
      (experimental) The KMS key used to encrypt this component.

      Default: - an Image Builder owned key will be used to encrypt the component.

    • getSupportedOsVersions

      @Stability(Experimental) @Nullable default List<OSVersion> getSupportedOsVersions()
      (experimental) The operating system versions supported by the component.

      Default: None

    • getTags

      @Stability(Experimental) @Nullable default Map<String,String> getTags()
      (experimental) The tags to apply to the component.

      Default: None

    • builder

      @Stability(Experimental) static ComponentProps.Builder builder()
      Returns:
      a ComponentProps.Builder of ComponentProps