Interface RegisterImageRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<RegisterImageRequest.Builder,RegisterImageRequest>, Ec2Request.Builder, SdkBuilder<RegisterImageRequest.Builder,RegisterImageRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
RegisterImageRequest
@Mutable @NotThreadSafe public static interface RegisterImageRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<RegisterImageRequest.Builder,RegisterImageRequest>

  • Method Details

    • 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 ACL 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 ACL in the Amazon S3 Service Developer Guide.
      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.

      If your account is not authorized to specify billing product codes, you can publish AMIs that include billable software and list them on the Amazon Web Services Marketplace. You must first register as a seller on the Amazon Web Services Marketplace. For more information, see Getting started as an Amazon Web Services Marketplace seller and AMI-based products in Amazon Web Services Marketplace in the Amazon Web Services Marketplace Seller Guide.

      Parameters:
      billingProducts - The billing product codes. Your account must be authorized to specify billing product codes.

      If your account is not authorized to specify billing product codes, you can publish AMIs that include billable software and list them on the Amazon Web Services Marketplace. You must first register as a seller on the Amazon Web Services Marketplace. For more information, see Getting started as an Amazon Web Services Marketplace seller and AMI-based products in Amazon Web Services Marketplace in the Amazon Web Services Marketplace Seller Guide.

      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.

      If your account is not authorized to specify billing product codes, you can publish AMIs that include billable software and list them on the Amazon Web Services Marketplace. You must first register as a seller on the Amazon Web Services Marketplace. For more information, see Getting started as an Amazon Web Services Marketplace seller and AMI-based products in Amazon Web Services Marketplace in the Amazon Web Services Marketplace Seller Guide.

      Parameters:
      billingProducts - The billing product codes. Your account must be authorized to specify billing product codes.

      If your account is not authorized to specify billing product codes, you can publish AMIs that include billable software and list them on the Amazon Web Services Marketplace. You must first register as a seller on the Amazon Web Services Marketplace. For more information, see Getting started as an Amazon Web Services Marketplace seller and AMI-based products in Amazon Web Services Marketplace in the Amazon Web Services Marketplace Seller Guide.

      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. A value of uefi-preferred indicates that the AMI supports both UEFI and Legacy BIOS.

      The operating system contained in the AMI must be configured to support the specified boot mode.

      For more information, see Instance launch behavior with Amazon EC2 boot modes in the Amazon EC2 User Guide.

      Parameters:
      bootMode - The boot mode of the AMI. A value of uefi-preferred indicates that the AMI supports both UEFI and Legacy BIOS.

      The operating system contained in the AMI must be configured to support the specified boot mode.

      For more information, see Instance launch behavior with Amazon EC2 boot modes in the Amazon EC2 User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • bootMode

      RegisterImageRequest.Builder bootMode(BootModeValues bootMode)

      The boot mode of the AMI. A value of uefi-preferred indicates that the AMI supports both UEFI and Legacy BIOS.

      The operating system contained in the AMI must be configured to support the specified boot mode.

      For more information, see Instance launch behavior with Amazon EC2 boot modes in the Amazon EC2 User Guide.

      Parameters:
      bootMode - The boot mode of the AMI. A value of uefi-preferred indicates that the AMI supports both UEFI and Legacy BIOS.

      The operating system contained in the AMI must be configured to support the specified boot mode.

      For more information, see Instance launch behavior with Amazon EC2 boot modes in the Amazon EC2 User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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 EC2 User Guide.

      Parameters:
      tpmSupport - Set to v2.0 to enable Trusted Platform Module (TPM) support. For more information, see NitroTPM in the Amazon EC2 User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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 EC2 User Guide.

      Parameters:
      tpmSupport - Set to v2.0 to enable Trusted Platform Module (TPM) support. For more information, see NitroTPM in the Amazon EC2 User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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 for Amazon EC2 instances in the Amazon EC2 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 for Amazon EC2 instances in the Amazon EC2 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 EC2 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 EC2 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:

    • 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 EC2 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 EC2 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:

    • tagSpecifications

      RegisterImageRequest.Builder tagSpecifications(Collection<TagSpecification> tagSpecifications)

      The tags to apply to the AMI.

      To tag the AMI, the value for ResourceType must be image. If you specify another value for ResourceType, the request fails.

      To tag an AMI after it has been registered, see CreateTags.

      Parameters:
      tagSpecifications - The tags to apply to the AMI.

      To tag the AMI, the value for ResourceType must be image. If you specify another value for ResourceType, the request fails.

      To tag an AMI after it has been registered, see CreateTags.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagSpecifications

      RegisterImageRequest.Builder tagSpecifications(TagSpecification... tagSpecifications)

      The tags to apply to the AMI.

      To tag the AMI, the value for ResourceType must be image. If you specify another value for ResourceType, the request fails.

      To tag an AMI after it has been registered, see CreateTags.

      Parameters:
      tagSpecifications - The tags to apply to the AMI.

      To tag the AMI, the value for ResourceType must be image. If you specify another value for ResourceType, the request fails.

      To tag an AMI after it has been registered, see CreateTags.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagSpecifications

      RegisterImageRequest.Builder tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)

      The tags to apply to the AMI.

      To tag the AMI, the value for ResourceType must be image. If you specify another value for ResourceType, the request fails.

      To tag an AMI after it has been registered, see CreateTags.

      This is a convenience method that creates an instance of the TagSpecification.Builder avoiding the need to create one manually via TagSpecification.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tagSpecifications(List<TagSpecification>).

      Parameters:
      tagSpecifications - a consumer that will call methods on TagSpecification.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dryRun

      RegisterImageRequest.Builder dryRun(Boolean dryRun)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

      Parameters:
      dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
      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.

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

    • 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:

    • 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:

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

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

    • 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, Create AMIs from local snapshots in the Amazon EBS 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, Create AMIs from local snapshots in the Amazon EBS 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, Create AMIs from local snapshots in the Amazon EBS 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, Create AMIs from local snapshots in the Amazon EBS 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, Create AMIs from local snapshots in the Amazon EBS 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<BlockDeviceMapping>).

      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:

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

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

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

    • overrideConfiguration

      RegisterImageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      RegisterImageRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.