Package software.amazon.awssdk.services.imagebuilder.model

Class ImportVmImageRequest

    • Method Detail

      • name

        public final String name()

        The name of the base image that is created by the import process.

        Returns:
        The name of the base image that is created by the import process.

      • semanticVersion

        public final String semanticVersion()

        The semantic version to attach to the base image that was created during the . You can assign values for the first three, and can filter on all of them.

        Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

        Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

        Returns:
        The semantic version to attach to the base image that was created during the import process. This version follows the semantic version syntax.

        The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

        Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

        Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

      • description

        public final String description()

        The description for the base image that is created by the import process.

        Returns:
        The description for the base image that is created by the import process.

      • platform

        public final Platform platform()

        The operating system platform for the imported VM.

        If the service returns an enum value that is not available in the current SDK version, platform will return Platform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from platformAsString().

        Returns:
        The operating system platform for the imported VM.
        See Also:
        Platform

      • platformAsString

        public final String platformAsString()

        The operating system platform for the imported VM.

        If the service returns an enum value that is not available in the current SDK version, platform will return Platform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from platformAsString().

        Returns:
        The operating system platform for the imported VM.
        See Also:
        Platform

      • osVersion

        public final String osVersion()

        The operating system version for the imported VM.

        Returns:
        The operating system version for the imported VM.

      • vmImportTaskId

        public final String vmImportTaskId()

        The importTaskId (API) or ImportTaskId (CLI) from the Amazon EC2 VM import process. Image Builder retrieves information from the import process to pull in the AMI that is created from the VM source as the base image for your recipe.

        Returns:
        The importTaskId (API) or ImportTaskId (CLI) from the Amazon EC2 VM import process. Image Builder retrieves information from the import process to pull in the AMI that is created from the VM source as the base image for your recipe.

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tags

        public final Map<String,​String> tags()

        Tags that are attached to the import resources.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        Tags that are attached to the import resources.

      • clientToken

        public final String clientToken()

        Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

        Returns:
        Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object