Interface Image.Builder

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

  • Method Details

    • platformDetails

      Image.Builder platformDetails(String platformDetails)

      The platform details associated with the billing code of the AMI. For more information, see Understand AMI billing information in the Amazon EC2 User Guide.

      Parameters:
      platformDetails - The platform details associated with the billing code of the AMI. For more information, see Understand AMI billing information in the Amazon EC2 User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • usageOperation

      Image.Builder usageOperation(String usageOperation)

      The operation of the Amazon EC2 instance and the billing code that is associated with the AMI. usageOperation corresponds to the lineitem/Operation column on your Amazon Web Services Cost and Usage Report and in the Amazon Web Services Price List API. You can view these fields on the Instances or AMIs pages in the Amazon EC2 console, or in the responses that are returned by the DescribeImages command in the Amazon EC2 API, or the describe-images command in the CLI.

      Parameters:
      usageOperation - The operation of the Amazon EC2 instance and the billing code that is associated with the AMI. usageOperation corresponds to the lineitem/Operation column on your Amazon Web Services Cost and Usage Report and in the Amazon Web Services Price List API. You can view these fields on the Instances or AMIs pages in the Amazon EC2 console, or in the responses that are returned by the DescribeImages command in the Amazon EC2 API, or the describe-images command in the CLI.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • blockDeviceMappings

      Image.Builder blockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)

      Any block device mapping entries.

      Parameters:
      blockDeviceMappings - Any block device mapping entries.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • blockDeviceMappings

      Image.Builder blockDeviceMappings(BlockDeviceMapping... blockDeviceMappings)

      Any block device mapping entries.

      Parameters:
      blockDeviceMappings - Any block device mapping entries.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • blockDeviceMappings

      Image.Builder blockDeviceMappings(Consumer<BlockDeviceMapping.Builder>... blockDeviceMappings)

      Any block device mapping entries.

      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:

    • description

      Image.Builder description(String description)

      The description of the AMI that was provided during image creation.

      Parameters:
      description - The description of the AMI that was provided during image creation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enaSupport

      Image.Builder enaSupport(Boolean enaSupport)

      Specifies whether enhanced networking with ENA is enabled.

      Parameters:
      enaSupport - Specifies whether enhanced networking with ENA is enabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hypervisor

      Image.Builder hypervisor(String hypervisor)

      The hypervisor type of the image. Only xen is supported. ovm is not supported.

      Parameters:
      hypervisor - The hypervisor type of the image. Only xen is supported. ovm is not supported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • hypervisor

      Image.Builder hypervisor(HypervisorType hypervisor)

      The hypervisor type of the image. Only xen is supported. ovm is not supported.

      Parameters:
      hypervisor - The hypervisor type of the image. Only xen is supported. ovm is not supported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • imageOwnerAlias

      Image.Builder imageOwnerAlias(String imageOwnerAlias)

      The owner alias (amazon | aws-backup-vault | aws-marketplace).

      Parameters:
      imageOwnerAlias - The owner alias (amazon | aws-backup-vault | aws-marketplace).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      Image.Builder name(String name)

      The name of the AMI that was provided during image creation.

      Parameters:
      name - The name of the AMI that was provided during image creation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rootDeviceName

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

    • rootDeviceType

      Image.Builder rootDeviceType(String rootDeviceType)

      The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.

      Parameters:
      rootDeviceType - The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • rootDeviceType

      Image.Builder rootDeviceType(DeviceType rootDeviceType)

      The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.

      Parameters:
      rootDeviceType - The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sriovNetSupport

      Image.Builder sriovNetSupport(String sriovNetSupport)

      Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

      Parameters:
      sriovNetSupport - Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stateReason

      Image.Builder stateReason(StateReason stateReason)

      The reason for the state change.

      Parameters:
      stateReason - The reason for the state change.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stateReason

      default Image.Builder stateReason(Consumer<StateReason.Builder> stateReason)

      The reason for the state change.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to stateReason(StateReason).

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

    • tags

      Image.Builder tags(Collection<Tag> tags)

      Any tags assigned to the image.

      Parameters:
      tags - Any tags assigned to the image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      Image.Builder tags(Tag... tags)

      Any tags assigned to the image.

      Parameters:
      tags - Any tags assigned to the image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      Image.Builder tags(Consumer<Tag.Builder>... tags)

      Any tags assigned to the image.

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

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

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

    • virtualizationType

      Image.Builder virtualizationType(String virtualizationType)

      The type of virtualization of the AMI.

      Parameters:
      virtualizationType - The type of virtualization of the AMI.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • virtualizationType

      Image.Builder virtualizationType(VirtualizationType virtualizationType)

      The type of virtualization of the AMI.

      Parameters:
      virtualizationType - The type of virtualization of the AMI.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • bootMode

      Image.Builder bootMode(String bootMode)

      The boot mode of the image. 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 image. 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

      Image.Builder bootMode(BootModeValues bootMode)

      The boot mode of the image. 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 image. 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

      Image.Builder tpmSupport(String tpmSupport)

      If the image is configured for NitroTPM support, the value is v2.0. For more information, see NitroTPM in the Amazon EC2 User Guide.

      Parameters:
      tpmSupport - If the image is configured for NitroTPM support, the value is v2.0. 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

      Image.Builder tpmSupport(TpmSupportValues tpmSupport)

      If the image is configured for NitroTPM support, the value is v2.0. For more information, see NitroTPM in the Amazon EC2 User Guide.

      Parameters:
      tpmSupport - If the image is configured for NitroTPM support, the value is v2.0. 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:

    • deprecationTime

      Image.Builder deprecationTime(String deprecationTime)

      The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.

      Parameters:
      deprecationTime - The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • imdsSupport

      Image.Builder imdsSupport(String imdsSupport)

      If v2.0, it indicates 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.

      Parameters:
      imdsSupport - If v2.0, it indicates 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • imdsSupport

      Image.Builder imdsSupport(ImdsSupportValues imdsSupport)

      If v2.0, it indicates 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.

      Parameters:
      imdsSupport - If v2.0, it indicates 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sourceInstanceId

      Image.Builder sourceInstanceId(String sourceInstanceId)

      The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This field only appears if the AMI was created using CreateImage.

      Parameters:
      sourceInstanceId - The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This field only appears if the AMI was created using CreateImage.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deregistrationProtection

      Image.Builder deregistrationProtection(String deregistrationProtection)

      Indicates whether deregistration protection is enabled for the AMI.

      Parameters:
      deregistrationProtection - Indicates whether deregistration protection is enabled for the AMI.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastLaunchedTime

      Image.Builder lastLaunchedTime(String lastLaunchedTime)

      The date and time, in ISO 8601 date-time format, when the AMI was last used to launch an EC2 instance. When the AMI is used to launch an instance, there is a 24-hour delay before that usage is reported.

      lastLaunchedTime data is available starting April 2017.

      Parameters:
      lastLaunchedTime - The date and time, in ISO 8601 date-time format, when the AMI was last used to launch an EC2 instance. When the AMI is used to launch an instance, there is a 24-hour delay before that usage is reported.

      lastLaunchedTime data is available starting April 2017.

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

    • imageAllowed

      Image.Builder imageAllowed(Boolean imageAllowed)

      If true, the AMI satisfies the criteria for Allowed AMIs and can be discovered and used in the account. If false and Allowed AMIs is set to enabled, the AMI can't be discovered or used in the account. If false and Allowed AMIs is set to audit-mode, the AMI can be discovered and used in the account.

      For more information, see Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs in Amazon EC2 User Guide.

      Parameters:
      imageAllowed - If true, the AMI satisfies the criteria for Allowed AMIs and can be discovered and used in the account. If false and Allowed AMIs is set to enabled, the AMI can't be discovered or used in the account. If false and Allowed AMIs is set to audit-mode, the AMI can be discovered and used in the account.

      For more information, see Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs in Amazon EC2 User Guide.

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

    • sourceImageId

      Image.Builder sourceImageId(String sourceImageId)

      The ID of the source AMI from which the AMI was created.

      The ID only appears if the AMI was created using CreateImage, CopyImage, or CreateRestoreImageTask. The ID does not appear if the AMI was created using any other API. For some older AMIs, the ID might not be available. For more information, see Identify the source AMI used to create a new Amazon EC2 AMI in the Amazon EC2 User Guide.

      Parameters:
      sourceImageId - The ID of the source AMI from which the AMI was created.

      The ID only appears if the AMI was created using CreateImage, CopyImage, or CreateRestoreImageTask. The ID does not appear if the AMI was created using any other API. For some older AMIs, the ID might not be available. For more information, see Identify the source AMI used to create a new Amazon EC2 AMI in the Amazon EC2 User Guide.

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

    • sourceImageRegion

      Image.Builder sourceImageRegion(String sourceImageRegion)

      The Region of the source AMI.

      The Region only appears if the AMI was created using CreateImage, CopyImage, or CreateRestoreImageTask. The Region does not appear if the AMI was created using any other API. For some older AMIs, the Region might not be available. For more information, see Identify the source AMI used to create a new Amazon EC2 AMI in the Amazon EC2 User Guide.

      Parameters:
      sourceImageRegion - The Region of the source AMI.

      The Region only appears if the AMI was created using CreateImage, CopyImage, or CreateRestoreImageTask. The Region does not appear if the AMI was created using any other API. For some older AMIs, the Region might not be available. For more information, see Identify the source AMI used to create a new Amazon EC2 AMI in the Amazon EC2 User Guide.

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

    • freeTierEligible

      Image.Builder freeTierEligible(Boolean freeTierEligible)

      Indicates whether the image is eligible for Amazon Web Services Free Tier.

      • If true, the AMI is eligible for Free Tier and can be used to launch instances under the Free Tier limits.

      • If false, the AMI is not eligible for Free Tier.

      Parameters:
      freeTierEligible - Indicates whether the image is eligible for Amazon Web Services Free Tier.

      • If true, the AMI is eligible for Free Tier and can be used to launch instances under the Free Tier limits.

      • If false, the AMI is not eligible for Free Tier.

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

    • imageId

      Image.Builder imageId(String imageId)

      The ID of the AMI.

      Parameters:
      imageId - The ID of the AMI.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • imageLocation

      Image.Builder imageLocation(String imageLocation)

      The location of the AMI.

      Parameters:
      imageLocation - The location of the AMI.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • state

      Image.Builder state(String state)

      The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

      Parameters:
      state - The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • state

      Image.Builder state(ImageState state)

      The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

      Parameters:
      state - The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ownerId

      Image.Builder ownerId(String ownerId)

      The ID of the Amazon Web Services account that owns the image.

      Parameters:
      ownerId - The ID of the Amazon Web Services account that owns the image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creationDate

      Image.Builder creationDate(String creationDate)

      The date and time the image was created.

      Parameters:
      creationDate - The date and time the image was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • productCodes

      Image.Builder productCodes(Collection<ProductCode> productCodes)

      Any product codes associated with the AMI.

      Parameters:
      productCodes - Any product codes associated with the AMI.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • productCodes

      Image.Builder productCodes(ProductCode... productCodes)

      Any product codes associated with the AMI.

      Parameters:
      productCodes - Any product codes associated with the AMI.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • productCodes

      Image.Builder productCodes(Consumer<ProductCode.Builder>... productCodes)

      Any product codes associated with the AMI.

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

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

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

    • architecture

      Image.Builder architecture(String architecture)

      The architecture of the image.

      Parameters:
      architecture - The architecture of the image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • architecture

      Image.Builder architecture(ArchitectureValues architecture)

      The architecture of the image.

      Parameters:
      architecture - The architecture of the image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • imageType

      Image.Builder imageType(String imageType)

      The type of image.

      Parameters:
      imageType - The type of image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • imageType

      Image.Builder imageType(ImageTypeValues imageType)

      The type of image.

      Parameters:
      imageType - The type of image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • kernelId

      Image.Builder kernelId(String kernelId)

      The kernel associated with the image, if any. Only applicable for machine images.

      Parameters:
      kernelId - The kernel associated with the image, if any. Only applicable for machine images.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ramdiskId

      Image.Builder ramdiskId(String ramdiskId)

      The RAM disk associated with the image, if any. Only applicable for machine images.

      Parameters:
      ramdiskId - The RAM disk associated with the image, if any. Only applicable for machine images.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • platform

      Image.Builder platform(String platform)

      This value is set to windows for Windows AMIs; otherwise, it is blank.

      Parameters:
      platform - This value is set to windows for Windows AMIs; otherwise, it is blank.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • platform

      Image.Builder platform(PlatformValues platform)

      This value is set to windows for Windows AMIs; otherwise, it is blank.

      Parameters:
      platform - This value is set to windows for Windows AMIs; otherwise, it is blank.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • publicLaunchPermissions

      Image.Builder publicLaunchPermissions(Boolean publicLaunchPermissions)

      Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.

      Parameters:
      publicLaunchPermissions - Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.