@Generated(value="software.amazon.awssdk:codegen") public final class RegisterImageRequest extends Ec2Request implements ToCopyableBuilder<RegisterImageRequest.Builder,RegisterImageRequest>
Contains the parameters for RegisterImage.
Modifier and Type | Class and Description |
---|---|
static interface |
RegisterImageRequest.Builder |
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 ). |
overrideConfiguration
copy
public final 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.
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.public final 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()
.
Default: For Amazon EBS-backed AMIs, i386
. For instance store-backed AMIs, the architecture
specified in the manifest file.
ArchitectureValues
public final 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()
.
Default: For Amazon EBS-backed AMIs, i386
. For instance store-backed AMIs, the architecture
specified in the manifest file.
ArchitectureValues
public final boolean hasBlockDeviceMappings()
public final 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.
public final String description()
A description for your AMI.
public final 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.
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.
public final String kernelId()
The ID of the kernel.
public final 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(_)
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
public final boolean hasBillingProducts()
public final 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.
public final String ramdiskId()
The ID of the RAM disk.
public final String rootDeviceName()
The device name of the root device volume (for example, /dev/sda1
).
/dev/sda1
).public final 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.
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.
public final String virtualizationType()
The type of virtualization (hvm
| paravirtual
).
Default: paravirtual
hvm
| paravirtual
).
Default: paravirtual
public RegisterImageRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<RegisterImageRequest.Builder,RegisterImageRequest>
toBuilder
in class Ec2Request
public static RegisterImageRequest.Builder builder()
public static Class<? extends RegisterImageRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.