Class Blueprint

java.lang.Object
software.amazon.awssdk.services.lightsail.model.Blueprint
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Blueprint.Builder,Blueprint>
@Generated("software.amazon.awssdk:codegen") public final class Blueprint extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Blueprint.Builder,Blueprint>

Describes a blueprint (a virtual private server image).

See Also:

  • Method Details

    • blueprintId

      public final String blueprintId()

      The ID for the virtual private server image (app_wordpress_x_x or app_lamp_x_x).

      Returns:
      The ID for the virtual private server image (app_wordpress_x_x or app_lamp_x_x ).

    • name

      public final String name()

      The friendly name of the blueprint (Amazon Linux).

      Returns:
      The friendly name of the blueprint (Amazon Linux).

    • group

      public final String group()

      The group name of the blueprint (amazon-linux).

      Returns:
      The group name of the blueprint (amazon-linux).

    • type

      public final BlueprintType type()

      The type of the blueprint (os or app).

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

      Returns:
      The type of the blueprint (os or app).
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the blueprint (os or app).

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

      Returns:
      The type of the blueprint (os or app).
      See Also:

    • description

      public final String description()

      The description of the blueprint.

      Returns:
      The description of the blueprint.

    • isActive

      public final Boolean isActive()

      A Boolean value indicating whether the blueprint is active. Inactive blueprints are listed to support customers with existing instances but are not necessarily available for launch of new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.

      Returns:
      A Boolean value indicating whether the blueprint is active. Inactive blueprints are listed to support customers with existing instances but are not necessarily available for launch of new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.

    • minPower

      public final Integer minPower()

      The minimum bundle power required to run this blueprint. For example, you need a bundle with a power value of 500 or more to create an instance that uses a blueprint with a minimum power value of 500. 0 indicates that the blueprint runs on all instance sizes.

      Returns:
      The minimum bundle power required to run this blueprint. For example, you need a bundle with a power value of 500 or more to create an instance that uses a blueprint with a minimum power value of 500. 0 indicates that the blueprint runs on all instance sizes.

    • version

      public final String version()

      The version number of the operating system, application, or stack ( 2016.03.0).

      Returns:
      The version number of the operating system, application, or stack ( 2016.03.0).

    • versionCode

      public final String versionCode()

      The version code.

      Returns:
      The version code.

    • productUrl

      public final String productUrl()

      The product URL to learn more about the image or blueprint.

      Returns:
      The product URL to learn more about the image or blueprint.

    • licenseUrl

      public final String licenseUrl()

      The end-user license agreement URL for the image or blueprint.

      Returns:
      The end-user license agreement URL for the image or blueprint.

    • platform

      public final InstancePlatform platform()

      The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.

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

      Returns:
      The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.
      See Also:

    • platformAsString

      public final String platformAsString()

      The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.

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

      Returns:
      The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.
      See Also:

    • appCategory

      public final AppCategory appCategory()

      Virtual computer blueprints that are supported by Lightsail for Research.

      This parameter only applies to Lightsail for Research resources.

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

      Returns:
      Virtual computer blueprints that are supported by Lightsail for Research.

      This parameter only applies to Lightsail for Research resources.

      See Also:

    • appCategoryAsString

      public final String appCategoryAsString()

      Virtual computer blueprints that are supported by Lightsail for Research.

      This parameter only applies to Lightsail for Research resources.

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

      Returns:
      Virtual computer blueprints that are supported by Lightsail for Research.

      This parameter only applies to Lightsail for Research resources.

      See Also:

    • toBuilder

      public Blueprint.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Blueprint.Builder,Blueprint>
      Returns:
      a builder for type T

    • builder

      public static Blueprint.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Blueprint.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.