RegisterImageRequest (AWS Java SDK :: Services

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`RegisterImageRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`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()`
`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
clone, finalize, 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
  - blockDeviceMappings
```
public List<BlockDeviceMapping> blockDeviceMappings()
```
    The block device mapping entries.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    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(_)
  - 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.
    
    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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RegisterImageRequest.Builder,RegisterImageRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static RegisterImageRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RegisterImageRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class RegisterImageRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

imageLocation

architecture

architectureAsString

blockDeviceMappings

description

enaSupport

kernelId

name

billingProducts

ramdiskId

rootDeviceName

sriovNetSupport

virtualizationType

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields