Package software.amazon.awssdk.services.ec2.model

Class ImageCriterionRequest

java.lang.Object

software.amazon.awssdk.services.ec2.model.ImageCriterionRequest

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ImageCriterionRequest.Builder,ImageCriterionRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ImageCriterionRequest
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ImageCriterionRequest.Builder,ImageCriterionRequest>

The list of criteria that are evaluated to determine whch AMIs are discoverable and usable in the account in the specified Amazon Web Services Region. Currently, the only criteria that can be specified are AMI providers.

Up to 10 imageCriteria objects can be specified, and up to a total of 200 values for all imageProviders. For more information, see JSON configuration for the Allowed AMIs criteria in the Amazon EC2 User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ImageCriterionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ImageCriterionRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasImageProviders()	For responses, this returns true if the service returned a value for the ImageProviders property.
List<String>	imageProviders()	A list of image providers whose AMIs are discoverable and useable in the account.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ImageCriterionRequest.Builder>	serializableBuilderClass()
ImageCriterionRequest.Builder	toBuilder()
String	toString()	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 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()

A list of image providers whose AMIs are discoverable and useable in the account. Up to a total of 200 values can be specified.

Possible values:

amazon: Allow AMIs created by Amazon Web Services.

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. When none is specified, no other values can be specified.

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:

A list of image providers whose AMIs are discoverable and useable in the account. Up to a total of 200 values can be specified.

Possible values:

amazon: Allow AMIs created by Amazon Web Services.

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. When none is specified, no other values can be specified.

toBuilder

public ImageCriterionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ImageCriterionRequest.Builder,ImageCriterionRequest>

builder

public static ImageCriterionRequest.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo