Package software.amazon.awssdk.services.lightsail.model

Interface Disk.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Disk.Builder,Disk>, SdkBuilder<Disk.Builder,Disk>, SdkPojo
Enclosing class:
Disk
public static interface Disk.Builder extends SdkPojo, CopyableBuilder<Disk.Builder,Disk>

  • Method Details

    • name

      Disk.Builder name(String name)

      The unique name of the disk.

      Parameters:
      name - The unique name of the disk.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • arn

      Disk.Builder arn(String arn)

      The Amazon Resource Name (ARN) of the disk.

      Parameters:
      arn - The Amazon Resource Name (ARN) of the disk.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • supportCode

      Disk.Builder supportCode(String supportCode)

      The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

      Parameters:
      supportCode - The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdAt

      Disk.Builder createdAt(Instant createdAt)

      The date when the disk was created.

      Parameters:
      createdAt - The date when the disk was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • location

      Disk.Builder location(ResourceLocation location)

      The AWS Region and Availability Zone where the disk is located.

      Parameters:
      location - The AWS Region and Availability Zone where the disk is located.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • location

      default Disk.Builder location(Consumer<ResourceLocation.Builder> location)

      The AWS Region and Availability Zone where the disk is located.

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

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

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

    • resourceType

      Disk.Builder resourceType(String resourceType)

      The Lightsail resource type (Disk).

      Parameters:
      resourceType - The Lightsail resource type (Disk).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • resourceType

      Disk.Builder resourceType(ResourceType resourceType)

      The Lightsail resource type (Disk).

      Parameters:
      resourceType - The Lightsail resource type (Disk).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      Disk.Builder tags(Collection<Tag> tags)

      The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

      Parameters:
      tags - The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      Disk.Builder tags(Tag... tags)

      The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

      Parameters:
      tags - The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

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

      The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

      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:

    • addOns

      Disk.Builder addOns(Collection<AddOn> addOns)

      An array of objects representing the add-ons enabled on the disk.

      Parameters:
      addOns - An array of objects representing the add-ons enabled on the disk.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • addOns

      Disk.Builder addOns(AddOn... addOns)

      An array of objects representing the add-ons enabled on the disk.

      Parameters:
      addOns - An array of objects representing the add-ons enabled on the disk.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • addOns

      Disk.Builder addOns(Consumer<AddOn.Builder>... addOns)

      An array of objects representing the add-ons enabled on the disk.

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

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

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

    • sizeInGb

      Disk.Builder sizeInGb(Integer sizeInGb)

      The size of the disk in GB.

      Parameters:
      sizeInGb - The size of the disk in GB.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isSystemDisk

      Disk.Builder isSystemDisk(Boolean isSystemDisk)

      A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).

      Parameters:
      isSystemDisk - A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • iops

      Disk.Builder iops(Integer iops)

      The input/output operations per second (IOPS) of the disk.

      Parameters:
      iops - The input/output operations per second (IOPS) of the disk.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • path

      Disk.Builder path(String path)

      The disk path.

      Parameters:
      path - The disk path.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • state

      Disk.Builder state(String state)

      Describes the status of the disk.

      Parameters:
      state - Describes the status of the disk.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • state

      Disk.Builder state(DiskState state)

      Describes the status of the disk.

      Parameters:
      state - Describes the status of the disk.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • attachedTo

      Disk.Builder attachedTo(String attachedTo)

      The resources to which the disk is attached.

      Parameters:
      attachedTo - The resources to which the disk is attached.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isAttached

      Disk.Builder isAttached(Boolean isAttached)

      A Boolean value indicating whether the disk is attached.

      Parameters:
      isAttached - A Boolean value indicating whether the disk is attached.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attachmentState

      @Deprecated Disk.Builder attachmentState(String attachmentState)
      Deprecated.

      (Discontinued) The attachment state of the disk.

      In releases prior to November 14, 2017, this parameter returned attached for system disks in the API response. It is now discontinued, but still included in the response. Use isAttached instead.

      Parameters:
      attachmentState - (Discontinued) The attachment state of the disk.

      In releases prior to November 14, 2017, this parameter returned attached for system disks in the API response. It is now discontinued, but still included in the response. Use isAttached instead.

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

    • gbInUse

      @Deprecated Disk.Builder gbInUse(Integer gbInUse)
      Deprecated.

      (Discontinued) The number of GB in use by the disk.

      In releases prior to November 14, 2017, this parameter was not included in the API response. It is now discontinued.

      Parameters:
      gbInUse - (Discontinued) The number of GB in use by the disk.

      In releases prior to November 14, 2017, this parameter was not included in the API response. It is now discontinued.

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

    • autoMountStatus

      Disk.Builder autoMountStatus(String autoMountStatus)

      The status of automatically mounting a storage disk to a virtual computer.

      This parameter only applies to Lightsail for Research resources.

      Parameters:
      autoMountStatus - The status of automatically mounting a storage disk to a virtual computer.

      This parameter only applies to Lightsail for Research resources.

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

    • autoMountStatus

      Disk.Builder autoMountStatus(AutoMountStatus autoMountStatus)

      The status of automatically mounting a storage disk to a virtual computer.

      This parameter only applies to Lightsail for Research resources.

      Parameters:
      autoMountStatus - The status of automatically mounting a storage disk to a virtual computer.

      This parameter only applies to Lightsail for Research resources.

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