Package software.amazon.awssdk.services.ec2.model

Class RegisterImageRequest

    • Method Detail

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

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

      • 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, Amazon EBS local snapshots on Outposts in the Amazon EC2 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, Amazon EBS local snapshots on Outposts in the Amazon EC2 User Guide.

      • description

        public final String description()

        A description for your AMI.

        Returns:
        A description for your AMI.

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

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

      • kernelId

        public final String kernelId()

        The ID of the kernel.

        Returns:
        The ID of the kernel.

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

      • 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 a seller and AMI-based products 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 a seller and AMI-based products in the Amazon Web Services Marketplace Seller Guide.

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

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

      • virtualizationType

        public final String virtualizationType()

        The type of virtualization (hvm | paravirtual).

        Default: paravirtual

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

        Default: paravirtual

      • 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 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 Boot modes in the Amazon EC2 User Guide.

        See Also:
        BootModeValues

      • 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 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 Boot modes in the Amazon EC2 User Guide.

        See Also:
        BootModeValues

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

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

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

      • 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