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

Interface Instance.Builder

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

  • Method Details

    • name

      Instance.Builder name(String name)

      The name the user gave the instance (Amazon_Linux-1GB-Ohio-1).

      Parameters:
      name - The name the user gave the instance (Amazon_Linux-1GB-Ohio-1).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • arn

      Instance.Builder arn(String arn)

      The Amazon Resource Name (ARN) of the instance ( arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).

      Parameters:
      arn - The Amazon Resource Name (ARN) of the instance ( arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • supportCode

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

      Instance.Builder createdAt(Instant createdAt)

      The timestamp when the instance was created (1479734909.17) in Unix time format.

      Parameters:
      createdAt - The timestamp when the instance was created (1479734909.17) in Unix time format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • location

      Instance.Builder location(ResourceLocation location)

      The region name and Availability Zone where the instance is located.

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

    • location

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

      The region name and Availability Zone where the instance 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

      Instance.Builder resourceType(String resourceType)

      The type of resource (usually Instance).

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

    • resourceType

      Instance.Builder resourceType(ResourceType resourceType)

      The type of resource (usually Instance).

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

    • tags

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

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

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

    • blueprintId

      Instance.Builder blueprintId(String blueprintId)

      The blueprint ID (os_amlinux_2016_03).

      Parameters:
      blueprintId - The blueprint ID (os_amlinux_2016_03).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • blueprintName

      Instance.Builder blueprintName(String blueprintName)

      The friendly name of the blueprint (Amazon Linux).

      Parameters:
      blueprintName - The friendly name of the blueprint (Amazon Linux).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • bundleId

      Instance.Builder bundleId(String bundleId)

      The bundle for the instance (micro_1_0).

      Parameters:
      bundleId - The bundle for the instance (micro_1_0).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • addOns

      Instance.Builder addOns(Collection<AddOn> addOns)

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

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

    • addOns

      Instance.Builder addOns(AddOn... addOns)

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

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

    • addOns

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

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

      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:

    • isStaticIp

      Instance.Builder isStaticIp(Boolean isStaticIp)

      A Boolean value indicating whether this instance has a static IP assigned to it.

      Parameters:
      isStaticIp - A Boolean value indicating whether this instance has a static IP assigned to it.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • privateIpAddress

      Instance.Builder privateIpAddress(String privateIpAddress)

      The private IP address of the instance.

      Parameters:
      privateIpAddress - The private IP address of the instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • publicIpAddress

      Instance.Builder publicIpAddress(String publicIpAddress)

      The public IP address of the instance.

      Parameters:
      publicIpAddress - The public IP address of the instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ipv6Addresses

      Instance.Builder ipv6Addresses(Collection<String> ipv6Addresses)

      The IPv6 addresses of the instance.

      Parameters:
      ipv6Addresses - The IPv6 addresses of the instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ipv6Addresses

      Instance.Builder ipv6Addresses(String... ipv6Addresses)

      The IPv6 addresses of the instance.

      Parameters:
      ipv6Addresses - The IPv6 addresses of the instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ipAddressType

      Instance.Builder ipAddressType(String ipAddressType)

      The IP address type of the instance.

      The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.

      Parameters:
      ipAddressType - The IP address type of the instance.

      The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.

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

    • ipAddressType

      Instance.Builder ipAddressType(IpAddressType ipAddressType)

      The IP address type of the instance.

      The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.

      Parameters:
      ipAddressType - The IP address type of the instance.

      The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.

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

    • hardware

      Instance.Builder hardware(InstanceHardware hardware)

      The size of the vCPU and the amount of RAM for the instance.

      Parameters:
      hardware - The size of the vCPU and the amount of RAM for the instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hardware

      default Instance.Builder hardware(Consumer<InstanceHardware.Builder> hardware)

      The size of the vCPU and the amount of RAM for the instance.

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

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

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

    • networking

      Instance.Builder networking(InstanceNetworking networking)

      Information about the public ports and monthly data transfer rates for the instance.

      Parameters:
      networking - Information about the public ports and monthly data transfer rates for the instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • networking

      default Instance.Builder networking(Consumer<InstanceNetworking.Builder> networking)

      Information about the public ports and monthly data transfer rates for the instance.

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

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

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

    • state

      Instance.Builder state(InstanceState state)

      The status code and the state (running) for the instance.

      Parameters:
      state - The status code and the state (running) for the instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • state

      default Instance.Builder state(Consumer<InstanceState.Builder> state)

      The status code and the state (running) for the instance.

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

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

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

    • username

      Instance.Builder username(String username)

      The user name for connecting to the instance (ec2-user).

      Parameters:
      username - The user name for connecting to the instance (ec2-user).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sshKeyName

      Instance.Builder sshKeyName(String sshKeyName)

      The name of the SSH key being used to connect to the instance (LightsailDefaultKeyPair).

      Parameters:
      sshKeyName - The name of the SSH key being used to connect to the instance (LightsailDefaultKeyPair).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metadataOptions

      Instance.Builder metadataOptions(InstanceMetadataOptions metadataOptions)

      The metadata options for the Amazon Lightsail instance.

      Parameters:
      metadataOptions - The metadata options for the Amazon Lightsail instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metadataOptions

      default Instance.Builder metadataOptions(Consumer<InstanceMetadataOptions.Builder> metadataOptions)

      The metadata options for the Amazon Lightsail instance.

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

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

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