RegisterImageRequest.Builder (AWS Java SDK :: Services

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<RegisterImageRequest.Builder,RegisterImageRequest>, Ec2Request.Builder, SdkBuilder<RegisterImageRequest.Builder,RegisterImageRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

RegisterImageRequest
```
public static interface RegisterImageRequest.Builder
extends Ec2Request.Builder, SdkPojo, CopyableBuilder<RegisterImageRequest.Builder,RegisterImageRequest>
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`RegisterImageRequest.Builder`	`architecture(ArchitectureValues architecture)` The architecture of the AMI.
`RegisterImageRequest.Builder`	`architecture(String architecture)` The architecture of the AMI.
`RegisterImageRequest.Builder`	`billingProducts(Collection<String> billingProducts)` The billing product codes.
`RegisterImageRequest.Builder`	`billingProducts(String... billingProducts)` The billing product codes.
`RegisterImageRequest.Builder`	`blockDeviceMappings(BlockDeviceMapping... blockDeviceMappings)` The block device mapping entries.
`RegisterImageRequest.Builder`	`blockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)` The block device mapping entries.
`RegisterImageRequest.Builder`	`blockDeviceMappings(Consumer<BlockDeviceMapping.Builder>... blockDeviceMappings)` The block device mapping entries.
`RegisterImageRequest.Builder`	`bootMode(BootModeValues bootMode)` The boot mode of the AMI.
`RegisterImageRequest.Builder`	`bootMode(String bootMode)` The boot mode of the AMI.
`RegisterImageRequest.Builder`	`description(String description)` A description for your AMI.
`RegisterImageRequest.Builder`	`enaSupport(Boolean enaSupport)` Set to `true` to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.
`RegisterImageRequest.Builder`	`imageLocation(String imageLocation)` The full path to your AMI manifest in Amazon S3 storage.
`RegisterImageRequest.Builder`	`imdsSupport(ImdsSupportValues imdsSupport)` Set to `v2.0` to indicate that IMDSv2 is specified in the AMI.
`RegisterImageRequest.Builder`	`imdsSupport(String imdsSupport)` Set to `v2.0` to indicate that IMDSv2 is specified in the AMI.
`RegisterImageRequest.Builder`	`kernelId(String kernelId)` The ID of the kernel.
`RegisterImageRequest.Builder`	`name(String name)` A name for your AMI.
`RegisterImageRequest.Builder`	`overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)`
`RegisterImageRequest.Builder`	`overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)`
`RegisterImageRequest.Builder`	`ramdiskId(String ramdiskId)` The ID of the RAM disk.
`RegisterImageRequest.Builder`	`rootDeviceName(String rootDeviceName)` The device name of the root device volume (for example, `/dev/sda1`).
`RegisterImageRequest.Builder`	`sriovNetSupport(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`	`tpmSupport(String tpmSupport)` Set to `v2.0` to enable Trusted Platform Module (TPM) support.
`RegisterImageRequest.Builder`	`tpmSupport(TpmSupportValues tpmSupport)` Set to `v2.0` to enable Trusted Platform Module (TPM) support.
`RegisterImageRequest.Builder`	`uefiData(String uefiData)` Base64 representation of the non-volatile UEFI variable store.
`RegisterImageRequest.Builder`	`virtualizationType(String virtualizationType)` The type of virtualization (`hvm` \| `paravirtual`).

Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder
build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - imageLocation
```
RegisterImageRequest.Builder imageLocation(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - architecture
```
RegisterImageRequest.Builder architecture(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ArchitectureValues, ArchitectureValues
  - architecture
```
RegisterImageRequest.Builder architecture(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ArchitectureValues, ArchitectureValues
  - blockDeviceMappings
```
RegisterImageRequest.Builder blockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)
```
    The block device mapping entries.
    
    If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume.
    
    If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
    
    Parameters:
    
    blockDeviceMappings - The block device mapping entries.
    
    If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume.
    
    If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - blockDeviceMappings
```
RegisterImageRequest.Builder blockDeviceMappings(BlockDeviceMapping... blockDeviceMappings)
```
    The block device mapping entries.
    
    If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume.
    
    If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
    
    Parameters:
    
    blockDeviceMappings - The block device mapping entries.
    
    If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume.
    
    If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - blockDeviceMappings
```
RegisterImageRequest.Builder blockDeviceMappings(Consumer<BlockDeviceMapping.Builder>... blockDeviceMappings)
```
    The block device mapping entries.
    
    If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume.
    
    If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
    This is a convenience method that creates an instance of the BlockDeviceMapping.Builder avoiding the need to create one manually via BlockDeviceMapping.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #blockDeviceMappings(List).
    
    Parameters:
    
    blockDeviceMappings - a consumer that will call methods on BlockDeviceMapping.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #blockDeviceMappings(java.util.Collection)
  - description
```
RegisterImageRequest.Builder description(String description)
```
    A description for your AMI.
    
    Parameters:
    
    description - A description for your AMI.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - enaSupport
```
RegisterImageRequest.Builder enaSupport(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - kernelId
```
RegisterImageRequest.Builder kernelId(String kernelId)
```
    The ID of the kernel.
    
    Parameters:
    
    kernelId - The ID of the kernel.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - name
```
RegisterImageRequest.Builder name(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(_)
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - billingProducts
```
RegisterImageRequest.Builder billingProducts(Collection<String> billingProducts)
```
    The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, you can use the Amazon Web Services Marketplace to bill for the use of an AMI.
    
    Parameters:
    
    billingProducts - The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, you can use the Amazon Web Services Marketplace to bill for the use of an AMI.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - billingProducts
```
RegisterImageRequest.Builder billingProducts(String... billingProducts)
```
    The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, you can use the Amazon Web Services Marketplace to bill for the use of an AMI.
    
    Parameters:
    
    billingProducts - The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, you can use the Amazon Web Services Marketplace to bill for the use of an AMI.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - ramdiskId
```
RegisterImageRequest.Builder ramdiskId(String ramdiskId)
```
    The ID of the RAM disk.
    
    Parameters:
    
    ramdiskId - The ID of the RAM disk.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - rootDeviceName
```
RegisterImageRequest.Builder rootDeviceName(String rootDeviceName)
```
    The device name of the root device volume (for example, /dev/sda1).
    
    Parameters:
    
    rootDeviceName - The device name of the root device volume (for example, /dev/sda1).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - sriovNetSupport
```
RegisterImageRequest.Builder sriovNetSupport(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - virtualizationType
```
RegisterImageRequest.Builder virtualizationType(String virtualizationType)
```
    The type of virtualization (hvm | paravirtual).
    
    Default: paravirtual
    
    Parameters:
    
    virtualizationType - The type of virtualization (hvm | paravirtual).
    
    Default: paravirtual
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - bootMode
```
RegisterImageRequest.Builder bootMode(String bootMode)
```
    The boot mode of the AMI. For more information, see Boot modes in the Amazon Elastic Compute Cloud User Guide.
    
    Parameters:
    
    bootMode - The boot mode of the AMI. For more information, see Boot modes in the Amazon Elastic Compute Cloud User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BootModeValues, BootModeValues
  - bootMode
```
RegisterImageRequest.Builder bootMode(BootModeValues bootMode)
```
    The boot mode of the AMI. For more information, see Boot modes in the Amazon Elastic Compute Cloud User Guide.
    
    Parameters:
    
    bootMode - The boot mode of the AMI. For more information, see Boot modes in the Amazon Elastic Compute Cloud User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BootModeValues, BootModeValues
  - tpmSupport
```
RegisterImageRequest.Builder tpmSupport(String tpmSupport)
```
    Set to v2.0 to enable Trusted Platform Module (TPM) support. For more information, see NitroTPM in the Amazon Elastic Compute Cloud User Guide.
    
    Parameters:
    
    tpmSupport - Set to v2.0 to enable Trusted Platform Module (TPM) support. For more information, see NitroTPM in the Amazon Elastic Compute Cloud User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TpmSupportValues, TpmSupportValues
  - tpmSupport
```
RegisterImageRequest.Builder tpmSupport(TpmSupportValues tpmSupport)
```
    Set to v2.0 to enable Trusted Platform Module (TPM) support. For more information, see NitroTPM in the Amazon Elastic Compute Cloud User Guide.
    
    Parameters:
    
    tpmSupport - Set to v2.0 to enable Trusted Platform Module (TPM) support. For more information, see NitroTPM in the Amazon Elastic Compute Cloud User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TpmSupportValues, TpmSupportValues
  - uefiData
```
RegisterImageRequest.Builder uefiData(String uefiData)
```
    Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot in the Amazon Elastic Compute Cloud User Guide.
    
    Parameters:
    
    uefiData - Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot in the Amazon Elastic Compute Cloud User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - imdsSupport
```
RegisterImageRequest.Builder imdsSupport(String imdsSupport)
```
    Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon Elastic Compute Cloud User Guide.
    
    If you set the value to v2.0, make sure that your AMI software can support IMDSv2.
    
    Parameters:
    
    imdsSupport - Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon Elastic Compute Cloud User Guide.
    
    If you set the value to v2.0, make sure that your AMI software can support IMDSv2.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ImdsSupportValues, ImdsSupportValues
  - imdsSupport
```
RegisterImageRequest.Builder imdsSupport(ImdsSupportValues imdsSupport)
```
    Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon Elastic Compute Cloud User Guide.
    
    If you set the value to v2.0, make sure that your AMI software can support IMDSv2.
    
    Parameters:
    
    imdsSupport - Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon Elastic Compute Cloud User Guide.
    
    If you set the value to v2.0, make sure that your AMI software can support IMDSv2.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ImdsSupportValues, ImdsSupportValues
  - overrideConfiguration
```
RegisterImageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder
  - overrideConfiguration
```
RegisterImageRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder

Interface RegisterImageRequest.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

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

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

Method Detail

imageLocation

architecture

architecture

blockDeviceMappings

blockDeviceMappings

blockDeviceMappings

description

enaSupport

kernelId

name

billingProducts

billingProducts

ramdiskId

rootDeviceName

sriovNetSupport

virtualizationType

bootMode

bootMode

tpmSupport

tpmSupport

uefiData

imdsSupport

imdsSupport

overrideConfiguration

overrideConfiguration