Interface CreateInstancesRequest.Builder

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

  • Method Details

    • instanceNames

      CreateInstancesRequest.Builder instanceNames(Collection<String> instanceNames)

      The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for example: ["MyFirstInstance","MySecondInstance"]

      Parameters:
      instanceNames - The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for example: ["MyFirstInstance","MySecondInstance"]
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceNames

      CreateInstancesRequest.Builder instanceNames(String... instanceNames)

      The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for example: ["MyFirstInstance","MySecondInstance"]

      Parameters:
      instanceNames - The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for example: ["MyFirstInstance","MySecondInstance"]
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • availabilityZone

      CreateInstancesRequest.Builder availabilityZone(String availabilityZone)

      The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). You can get a list of Availability Zones by using the get regions operation. Be sure to add the include Availability Zones parameter to your request.

      Parameters:
      availabilityZone - The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). You can get a list of Availability Zones by using the get regions operation. Be sure to add the include Availability Zones parameter to your request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customImageName

      @Deprecated CreateInstancesRequest.Builder customImageName(String customImageName)
      Deprecated.

      (Discontinued) The name for your custom image.

      In releases prior to June 12, 2017, this parameter was ignored by the API. It is now discontinued.

      Parameters:
      customImageName - (Discontinued) The name for your custom image.

      In releases prior to June 12, 2017, this parameter was ignored by the API. It is now discontinued.

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

    • blueprintId

      CreateInstancesRequest.Builder blueprintId(String blueprintId)

      The ID for a virtual private server image (app_wordpress_x_x or app_lamp_x_x). Use the get blueprints operation to return a list of available images (or blueprints).

      Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.

      Parameters:
      blueprintId - The ID for a virtual private server image (app_wordpress_x_x or app_lamp_x_x ). Use the get blueprints operation to return a list of available images (or blueprints).

      Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.

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

    • bundleId

      CreateInstancesRequest.Builder bundleId(String bundleId)

      The bundle of specification information for your virtual private server (or instance), including the pricing plan (medium_x_x).

      Parameters:
      bundleId - The bundle of specification information for your virtual private server (or instance), including the pricing plan (medium_x_x).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userData

      CreateInstancesRequest.Builder userData(String userData)

      A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update.

      Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, see the Amazon Lightsail Developer Guide.

      Parameters:
      userData - A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update.

      Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, see the Amazon Lightsail Developer Guide.

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

    • keyPairName

      CreateInstancesRequest.Builder keyPairName(String keyPairName)

      The name of your key pair.

      Parameters:
      keyPairName - The name of your key pair.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateInstancesRequest.Builder tags(Collection<Tag> tags)

      The tag keys and optional values to add to the resource during create.

      Use the TagResource action to tag a resource after it's created.

      Parameters:
      tags - The tag keys and optional values to add to the resource during create.

      Use the TagResource action to tag a resource after it's created.

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

    • tags

      CreateInstancesRequest.Builder tags(Tag... tags)

      The tag keys and optional values to add to the resource during create.

      Use the TagResource action to tag a resource after it's created.

      Parameters:
      tags - The tag keys and optional values to add to the resource during create.

      Use the TagResource action to tag a resource after it's created.

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

    • tags

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

      The tag keys and optional values to add to the resource during create.

      Use the TagResource action to tag a resource after it's created.

      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

      CreateInstancesRequest.Builder addOns(Collection<AddOnRequest> addOns)

      An array of objects representing the add-ons to enable for the new instance.

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

    • addOns

      CreateInstancesRequest.Builder addOns(AddOnRequest... addOns)

      An array of objects representing the add-ons to enable for the new instance.

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

    • addOns

      CreateInstancesRequest.Builder addOns(Consumer<AddOnRequest.Builder>... addOns)

      An array of objects representing the add-ons to enable for the new instance.

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

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

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

    • ipAddressType

      CreateInstancesRequest.Builder ipAddressType(String ipAddressType)

      The IP address type for the instance.

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

      The default value is dualstack.

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

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

      The default value is dualstack.

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

    • ipAddressType

      CreateInstancesRequest.Builder ipAddressType(IpAddressType ipAddressType)

      The IP address type for the instance.

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

      The default value is dualstack.

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

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

      The default value is dualstack.

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

    • overrideConfiguration

      CreateInstancesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateInstancesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.