Class ImageCriterion

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

The criteria that are evaluated to determine which AMIs are discoverable and usable in your account for the specified Amazon Web Services Region.

For more information, see How Allowed AMIs works in the Amazon EC2 User Guide.

See Also:

  • Method Details

    • hasImageProviders

      public final boolean hasImageProviders()
      For responses, this returns true if the service returned a value for the ImageProviders 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.

    • imageProviders

      public final List<String> imageProviders()

      The image providers whose images are allowed.

      Possible values:

      • amazon: Allow AMIs created by Amazon or verified providers.

      • aws-marketplace: Allow AMIs created by verified providers in the Amazon Web Services Marketplace.

      • aws-backup-vault: Allow AMIs created by Amazon Web Services Backup.

      • 12-digit account ID: Allow AMIs created by this account. One or more account IDs can be specified.

      • none: Allow AMIs created by your own account only.

      Maximum: 200 values

      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 hasImageProviders() method.

      Returns:
      The image providers whose images are allowed.

      Possible values:

      • amazon: Allow AMIs created by Amazon or verified providers.

      • aws-marketplace: Allow AMIs created by verified providers in the Amazon Web Services Marketplace.

      • aws-backup-vault: Allow AMIs created by Amazon Web Services Backup.

      • 12-digit account ID: Allow AMIs created by this account. One or more account IDs can be specified.

      • none: Allow AMIs created by your own account only.

      Maximum: 200 values

    • hasMarketplaceProductCodes

      public final boolean hasMarketplaceProductCodes()
      For responses, this returns true if the service returned a value for the MarketplaceProductCodes 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.

    • marketplaceProductCodes

      public final List<String> marketplaceProductCodes()

      The Amazon Web Services Marketplace product codes for allowed images.

      Length: 1-25 characters

      Valid characters: Letters (A–Z, a–z) and numbers (0–9)

      Maximum: 50 values

      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 hasMarketplaceProductCodes() method.

      Returns:
      The Amazon Web Services Marketplace product codes for allowed images.

      Length: 1-25 characters

      Valid characters: Letters (A–Z, a–z) and numbers (0–9)

      Maximum: 50 values

    • hasImageNames

      public final boolean hasImageNames()
      For responses, this returns true if the service returned a value for the ImageNames 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.

    • imageNames

      public final List<String> imageNames()

      The names of allowed images. Names can include wildcards (? and *).

      Length: 1–128 characters. With ?, the minimum is 3 characters.

      Valid characters:

      • Letters: A–Z, a–z

      • Numbers: 0–9

      • Special characters: ( ) [ ] . / - ' @ _ * ?

      • Spaces

      Maximum: 50 values

      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 hasImageNames() method.

      Returns:
      The names of allowed images. Names can include wildcards (? and *).

      Length: 1–128 characters. With ?, the minimum is 3 characters.

      Valid characters:

      • Letters: A–Z, a–z

      • Numbers: 0–9

      • Special characters: ( ) [ ] . / - ' @ _ * ?

      • Spaces

      Maximum: 50 values

    • deprecationTimeCondition

      public final DeprecationTimeCondition deprecationTimeCondition()

      The maximum period since deprecation for allowed images.

      Returns:
      The maximum period since deprecation for allowed images.

    • creationDateCondition

      public final CreationDateCondition creationDateCondition()

      The maximum age for allowed images.

      Returns:
      The maximum age for allowed images.

    • toBuilder

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

    • builder

      public static ImageCriterion.Builder builder()

    • serializableBuilderClass

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