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("software.amazon.awssdk:codegen") public final class RegisterImageRequest extends Ec2Request implements ToCopyableBuilder<RegisterImageRequest.Builder,RegisterImageRequest>

Contains the parameters for RegisterImage.

  • Method Details

    • imageLocation

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

    • hasBillingProducts

      public final boolean hasBillingProducts()
      For responses, this returns true if the service returned a value for the BillingProducts property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • billingProducts

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

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

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBillingProducts() method.

      Returns:
      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.

    • bootMode

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

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

      Returns:
      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.

      See Also:

    • bootModeAsString

      public final String bootModeAsString()

      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.

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

      Returns:
      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.

      See Also:

    • tpmSupport

      public final TpmSupportValues tpmSupport()

      Set to v2.0 to enable Trusted Platform Module (TPM) support. For more information, see NitroTPM in the Amazon EC2 User Guide.

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

      Returns:
      Set to v2.0 to enable Trusted Platform Module (TPM) support. For more information, see NitroTPM in the Amazon EC2 User Guide.
      See Also:

    • tpmSupportAsString

      public final String tpmSupportAsString()

      Set to v2.0 to enable Trusted Platform Module (TPM) support. For more information, see NitroTPM in the Amazon EC2 User Guide.

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

      Returns:
      Set to v2.0 to enable Trusted Platform Module (TPM) support. For more information, see NitroTPM in the Amazon EC2 User Guide.
      See Also:

    • uefiData

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

      Returns:
      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.

    • imdsSupport

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

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

      Returns:
      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.

      See Also:

    • imdsSupportAsString

      public final String imdsSupportAsString()

      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.

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

      Returns:
      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.

      See Also:

    • hasTagSpecifications

      public final boolean hasTagSpecifications()
      For responses, this returns true if the service returned a value for the TagSpecifications property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tagSpecifications

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

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

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTagSpecifications() method.

      Returns:
      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.

    • dryRun

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

      Returns:
      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.

    • name

      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(_)

      Returns:
      A name for your AMI.

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

    • description

      public final String description()

      A description for your AMI.

      Returns:
      A description for your AMI.

    • architecture

      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().

      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:

    • architectureAsString

      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().

      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:

    • kernelId

      public final String kernelId()

      The ID of the kernel.

      Returns:
      The ID of the kernel.

    • ramdiskId

      public final String ramdiskId()

      The ID of the RAM disk.

      Returns:
      The ID of the RAM disk.

    • rootDeviceName

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

    • hasBlockDeviceMappings

      public final boolean hasBlockDeviceMappings()
      For responses, this returns true if the service returned a value for the BlockDeviceMappings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • blockDeviceMappings

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

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

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBlockDeviceMappings() method.

      Returns:
      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.

    • virtualizationType

      public final String virtualizationType()

      The type of virtualization (hvm | paravirtual).

      Default: paravirtual

      Returns:
      The type of virtualization (hvm | paravirtual).

      Default: paravirtual

    • sriovNetSupport

      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.

      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.

    • enaSupport

      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.

      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.

    • 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 final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.