software.amazon.awssdk.services.ec2.model

Class RegisterImageRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ec2.model.Ec2Request

software.amazon.awssdk.services.ec2.model.RegisterImageRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<RegisterImageRequest.Builder,RegisterImageRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class RegisterImageRequest
extends Ec2Request
implements ToCopyableBuilder<RegisterImageRequest.Builder,RegisterImageRequest>

Contains the parameters for RegisterImage.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RegisterImageRequest.Builder

Method Summary

Modifier and Type	Method and Description
ArchitectureValues	architecture() The architecture of the AMI.
String	architectureAsString() The architecture of the AMI.
List<String>	billingProducts() The billing product codes.
List<BlockDeviceMapping>	blockDeviceMappings() The block device mapping entries.
static RegisterImageRequest.Builder	builder()
String	description() A description for your AMI.
Boolean	enaSupport() Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
boolean	hasBillingProducts() Returns true if the BillingProducts property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasBlockDeviceMappings() Returns true if the BlockDeviceMappings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
String	imageLocation() The full path to your AMI manifest in Amazon S3 storage.
String	kernelId() The ID of the kernel.
String	name() A name for your AMI.
String	ramdiskId() The ID of the RAM disk.
String	rootDeviceName() The device name of the root device volume (for example, /dev/sda1).
List<SdkField<?>>	sdkFields()
static Class<? extends RegisterImageRequest.Builder>	serializableBuilderClass()
String	sriovNetSupport() Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.
RegisterImageRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
String	virtualizationType() The type of virtualization (hvm | paravirtual).

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

imageLocation

public String imageLocation()

The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the aws-exec-read canned access control list (ACL) to ensure that it can be accessed by Amazon EC2. For more information, see Canned ACLs in the Amazon S3 Service Developer Guide.

Returns:

The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the aws-exec-read canned access control list (ACL) to ensure that it can be accessed by Amazon EC2. For more information, see Canned ACLs in the Amazon S3 Service Developer Guide.

architecture

public ArchitectureValues architecture()

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

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

Returns:

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

See Also:

ArchitectureValues

architectureAsString

public String architectureAsString()

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

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

Returns:

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

See Also:

ArchitectureValues

hasBlockDeviceMappings

public boolean hasBlockDeviceMappings()

Returns true if the BlockDeviceMappings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

blockDeviceMappings

public List<BlockDeviceMapping> blockDeviceMappings()

The block device mapping entries.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasBlockDeviceMappings() to see if a value was sent in this field.

Returns:

The block device mapping entries.

description

public String description()

A description for your AMI.

Returns:

A description for your AMI.

enaSupport

public Boolean enaSupport()

Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

Returns:

Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

kernelId

public String kernelId()

The ID of the kernel.

Returns:

The ID of the kernel.

name

public String name()

A name for your AMI.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

Returns:

A name for your AMI.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

hasBillingProducts

public boolean hasBillingProducts()

Returns true if the BillingProducts property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

billingProducts

public List<String> billingProducts()

The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, you can use the AWS Marketplace to bill for the use of an AMI.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasBillingProducts() to see if a value was sent in this field.

Returns:

The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, you can use the AWS Marketplace to bill for the use of an AMI.

ramdiskId

public String ramdiskId()

The ID of the RAM disk.

Returns:

The ID of the RAM disk.

rootDeviceName

public String rootDeviceName()

The device name of the root device volume (for example, /dev/sda1).

Returns:

The device name of the root device volume (for example, /dev/sda1).

sriovNetSupport

public String sriovNetSupport()

Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.

There is no way to disable sriovNetSupport at this time.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

Returns:

Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.

There is no way to disable sriovNetSupport at this time.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

virtualizationType

public String virtualizationType()

The type of virtualization (hvm | paravirtual).

Default: paravirtual

Returns:

The type of virtualization (hvm | paravirtual).

Default: paravirtual

toBuilder

public RegisterImageRequest.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<RegisterImageRequest.Builder,RegisterImageRequest>

Specified by:

toBuilder in class Ec2Request

Returns:

a builder for type T

builder

public static RegisterImageRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public 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 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public 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.