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

Enum ComponentAction

java.lang.Object
java.lang.Enum<ComponentAction>
software.amazon.awscdk.services.imagebuilder.alpha.ComponentAction
All Implemented Interfaces:
Serializable, Comparable<ComponentAction>, java.lang.constant.Constable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-20T23:37:34.438Z") @Stability(Experimental) public enum ComponentAction extends Enum<ComponentAction>
(experimental) The action for a step within the component document.

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();

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    APPEND_FILE
    (experimental) The AppendFile action adds the provided content to the pre-existing content of a file.
    ASSERT
    (experimental) The Assert action performs value with comparison/logic operators, and succeeds/fails the step based on the outcome of the assertion.
    COPY_FILE
    (experimental) The CopyFile action copies files from a source file to a destination.
    COPY_FOLDER
    (experimental) The CopyFolder action copies folders from a source to a destination.
    CREATE_FILE
    (experimental) The CreateFile action creates a file in the provided location.
    CREATE_FOLDER
    (experimental) The CreateFolder action creates a folder in the provided location.
    CREATE_SYMLINK
    (experimental) The CreateSymlink action creates symbolic links from a given path to a target.
    DELETE_FILE
    (experimental) The DeleteFile action deletes file(s) in the provided location.
    DELETE_FOLDER
    (experimental) The DeleteFolder action deletes folders in the provided location.
    EXECUTE_BASH
    (experimental) The ExecuteBash action runs bash scripts with inline bash commands.
    EXECUTE_BINARY
    (experimental) The ExecuteBinary action runs a provided binary executable.
    EXECUTE_DOCUMENT
    (experimental) The ExecuteDocument action allows running other component documents from within a given component.
    EXECUTE_POWERSHELL
    (experimental) The ExecutePowershell action runs PowerShell scripts with inline PowerShell commands.
    INSTALL_MSI
    (experimental) The InstallMSI action runs a Windows application with the provided MSI file.
    LIST_FILES
    (experimental) The ListFiles action lists files in the provided folder.
    MOVE_FILE
    (experimental) The MoveFile action moves files from a source to a destination.
    MOVE_FOLDER
    (experimental) The MoveFolder action moves folders from a source to a destination.
    READ_FILE
    (experimental) The ReadFile action reads the content of a text file.
    REBOOT
    (experimental) The Reboot action reboots the instance.
    S3_DOWNLOAD
    (experimental) The S3Download action downloads an Amazon S3 object/folder to a local destination.
    S3_UPLOAD
    (experimental) The S3Upload action uploads a file or folder to an Amazon S3 location.
    SET_FILE_ENCODING
    (experimental) The SetFileEncoding action modifies the encoding property of an existing file.
    SET_FILE_OWNER
    (experimental) The SetFileOwner action modifies the owner and group ownership properties of an existing file.
    SET_FILE_PERMISSIONS
    (experimental) The SetFilePermissions action modifies the permission of an existing file.
    SET_FOLDER_OWNER
    (experimental) The SetFolderOwner action recursively modifies the owner and group ownership properties of an existing folder.
    SET_FOLDER_PERMISSIONS
    (experimental) The SetFolderPermissions action recursively modifies the permissions of an existing folder and all of its subfiles and subfolders.
    SET_REGISTRY
    (experimental) The SetRegistry action sets the value for the specified Windows registry key.
    UNINSTALL_MSI
    (experimental) The UninstallMSI action removes a Windows application using an MSI file.
    UPDATE_OS
    (experimental) The UpdateOS action installs OS updates.
    WEB_DOWNLOAD
    (experimental) The WebDownload action downloads files from a URL to a local destination.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ComponentAction
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static ComponentAction[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • APPEND_FILE

      @Stability(Experimental) public static final ComponentAction APPEND_FILE
      (experimental) The AppendFile action adds the provided content to the pre-existing content of a file.

    • ASSERT

      @Stability(Experimental) public static final ComponentAction ASSERT
      (experimental) The Assert action performs value with comparison/logic operators, and succeeds/fails the step based on the outcome of the assertion.

    • COPY_FILE

      @Stability(Experimental) public static final ComponentAction COPY_FILE
      (experimental) The CopyFile action copies files from a source file to a destination.

    • COPY_FOLDER

      @Stability(Experimental) public static final ComponentAction COPY_FOLDER
      (experimental) The CopyFolder action copies folders from a source to a destination.

    • CREATE_FILE

      @Stability(Experimental) public static final ComponentAction CREATE_FILE
      (experimental) The CreateFile action creates a file in the provided location.

    • CREATE_FOLDER

      @Stability(Experimental) public static final ComponentAction CREATE_FOLDER
      (experimental) The CreateFolder action creates a folder in the provided location.

    • DELETE_FILE

      @Stability(Experimental) public static final ComponentAction DELETE_FILE
      (experimental) The DeleteFile action deletes file(s) in the provided location.

    • DELETE_FOLDER

      @Stability(Experimental) public static final ComponentAction DELETE_FOLDER
      (experimental) The DeleteFolder action deletes folders in the provided location.

    • EXECUTE_BASH

      @Stability(Experimental) public static final ComponentAction EXECUTE_BASH
      (experimental) The ExecuteBash action runs bash scripts with inline bash commands.

    • EXECUTE_BINARY

      @Stability(Experimental) public static final ComponentAction EXECUTE_BINARY
      (experimental) The ExecuteBinary action runs a provided binary executable.

    • EXECUTE_DOCUMENT

      @Stability(Experimental) public static final ComponentAction EXECUTE_DOCUMENT
      (experimental) The ExecuteDocument action allows running other component documents from within a given component.

    • EXECUTE_POWERSHELL

      @Stability(Experimental) public static final ComponentAction EXECUTE_POWERSHELL
      (experimental) The ExecutePowershell action runs PowerShell scripts with inline PowerShell commands.

    • INSTALL_MSI

      @Stability(Experimental) public static final ComponentAction INSTALL_MSI
      (experimental) The InstallMSI action runs a Windows application with the provided MSI file.

    • LIST_FILES

      @Stability(Experimental) public static final ComponentAction LIST_FILES
      (experimental) The ListFiles action lists files in the provided folder.

    • MOVE_FILE

      @Stability(Experimental) public static final ComponentAction MOVE_FILE
      (experimental) The MoveFile action moves files from a source to a destination.

    • MOVE_FOLDER

      @Stability(Experimental) public static final ComponentAction MOVE_FOLDER
      (experimental) The MoveFolder action moves folders from a source to a destination.

    • READ_FILE

      @Stability(Experimental) public static final ComponentAction READ_FILE
      (experimental) The ReadFile action reads the content of a text file.

    • REBOOT

      @Stability(Experimental) public static final ComponentAction REBOOT
      (experimental) The Reboot action reboots the instance.

    • SET_FILE_ENCODING

      @Stability(Experimental) public static final ComponentAction SET_FILE_ENCODING
      (experimental) The SetFileEncoding action modifies the encoding property of an existing file.

    • SET_FILE_OWNER

      @Stability(Experimental) public static final ComponentAction SET_FILE_OWNER
      (experimental) The SetFileOwner action modifies the owner and group ownership properties of an existing file.

    • SET_FOLDER_OWNER

      @Stability(Experimental) public static final ComponentAction SET_FOLDER_OWNER
      (experimental) The SetFolderOwner action recursively modifies the owner and group ownership properties of an existing folder.

    • SET_FILE_PERMISSIONS

      @Stability(Experimental) public static final ComponentAction SET_FILE_PERMISSIONS
      (experimental) The SetFilePermissions action modifies the permission of an existing file.

    • SET_FOLDER_PERMISSIONS

      @Stability(Experimental) public static final ComponentAction SET_FOLDER_PERMISSIONS
      (experimental) The SetFolderPermissions action recursively modifies the permissions of an existing folder and all of its subfiles and subfolders.

    • SET_REGISTRY

      @Stability(Experimental) public static final ComponentAction SET_REGISTRY
      (experimental) The SetRegistry action sets the value for the specified Windows registry key.

    • S3_DOWNLOAD

      @Stability(Experimental) public static final ComponentAction S3_DOWNLOAD
      (experimental) The S3Download action downloads an Amazon S3 object/folder to a local destination.

    • S3_UPLOAD

      @Stability(Experimental) public static final ComponentAction S3_UPLOAD
      (experimental) The S3Upload action uploads a file or folder to an Amazon S3 location.

    • UNINSTALL_MSI

      @Stability(Experimental) public static final ComponentAction UNINSTALL_MSI
      (experimental) The UninstallMSI action removes a Windows application using an MSI file.

    • UPDATE_OS

      @Stability(Experimental) public static final ComponentAction UPDATE_OS
      (experimental) The UpdateOS action installs OS updates.

    • WEB_DOWNLOAD

      @Stability(Experimental) public static final ComponentAction WEB_DOWNLOAD
      (experimental) The WebDownload action downloads files from a URL to a local destination.

  • Method Details

    • values

      public static ComponentAction[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static ComponentAction valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null