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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceImageCriterion.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ImageCriterion.Builderbuilder()CreationDateConditioncreationDateCondition()The maximum age for allowed images.DeprecationTimeConditiondeprecationTimeCondition()The maximum period since deprecation for allowed images.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasImageNames()For responses, this returns true if the service returned a value for the ImageNames property.booleanhasImageProviders()For responses, this returns true if the service returned a value for the ImageProviders property.booleanhasMarketplaceProductCodes()For responses, this returns true if the service returned a value for the MarketplaceProductCodes property.List<String>imageNames()The names of allowed images.List<String>imageProviders()The image providers whose images are allowed.List<String>marketplaceProductCodes()The Amazon Web Services Marketplace product codes for allowed images.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends ImageCriterion.Builder>serializableBuilderClass()ImageCriterion.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 theisEmpty()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 theisEmpty()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 theisEmpty()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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ImageCriterion.Builder,ImageCriterion>
-
builder
public static ImageCriterion.Builder builder()
-
serializableBuilderClass
public static Class<? extends ImageCriterion.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-