Class ImageMetadata

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

Information about the AMI.

See Also:

  • Method Details

    • imageId

      public final String imageId()

      The ID of the AMI.

      Returns:
      The ID of the AMI.

    • name

      public final String name()

      The name of the AMI.

      Returns:
      The name of the AMI.

    • ownerId

      public final String ownerId()

      The ID of the Amazon Web Services account that owns the AMI.

      Returns:
      The ID of the Amazon Web Services account that owns the AMI.

    • state

      public final ImageState state()

      The current state of the AMI. If the state is available, the AMI is successfully registered and can be used to launch an instance.

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

      Returns:
      The current state of the AMI. If the state is available, the AMI is successfully registered and can be used to launch an instance.
      See Also:

    • stateAsString

      public final String stateAsString()

      The current state of the AMI. If the state is available, the AMI is successfully registered and can be used to launch an instance.

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

      Returns:
      The current state of the AMI. If the state is available, the AMI is successfully registered and can be used to launch an instance.
      See Also:

    • imageOwnerAlias

      public final String imageOwnerAlias()

      The alias of the AMI owner.

      Valid values: amazon | aws-backup-vault | aws-marketplace

      Returns:
      The alias of the AMI owner.

      Valid values: amazon | aws-backup-vault | aws-marketplace

    • creationDate

      public final String creationDate()

      The date and time the AMI was created.

      Returns:
      The date and time the AMI was created.

    • deprecationTime

      public final String deprecationTime()

      The deprecation date and time of the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ.

      Returns:
      The deprecation date and time of the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ.

    • imageAllowed

      public final Boolean imageAllowed()

      If true, the AMI satisfies the criteria for Allowed AMIs and can be discovered and used in the account. If false, the AMI can't be discovered or used in the account.

      For more information, see Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs in Amazon EC2 User Guide.

      Returns:
      If true, the AMI satisfies the criteria for Allowed AMIs and can be discovered and used in the account. If false, the AMI can't be discovered or used in the account.

      For more information, see Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs in Amazon EC2 User Guide.

    • isPublic

      public final Boolean isPublic()

      Indicates whether the AMI has public launch permissions. A value of true means this AMI has public launch permissions, while false means it has only implicit (AMI owner) or explicit (shared with your account) launch permissions.

      Returns:
      Indicates whether the AMI has public launch permissions. A value of true means this AMI has public launch permissions, while false means it has only implicit (AMI owner) or explicit (shared with your account) launch permissions.

    • toBuilder

      public ImageMetadata.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<ImageMetadata.Builder,ImageMetadata>
      Returns:
      a builder for type T

    • builder

      public static ImageMetadata.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ImageMetadata.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.