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

Class CreateInstancesRequest

    • Method Detail

      • hasInstanceNames

        public final boolean hasInstanceNames()
        For responses, this returns true if the service returned a value for the InstanceNames 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.

      • instanceNames

        public final List<String> instanceNames()

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

        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 hasInstanceNames() method.

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

      • availabilityZone

        public final 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.

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

      • customImageName

        @Deprecated
public final 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.

        Returns:
        (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.

      • blueprintId

        public final String blueprintId()

        The ID for a virtual private server image (app_wordpress_4_4 or app_lamp_7_0). 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:
        The ID for a virtual private server image (app_wordpress_4_4 or app_lamp_7_0). 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.

      • bundleId

        public final String bundleId()

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

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

      • userData

        public final 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.

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

      • keyPairName

        public final String keyPairName()

        The name of your key pair.

        Returns:
        The name of your key pair.

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags 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.

      • tags

        public final List<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.

        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 hasTags() method.

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

      • hasAddOns

        public final boolean hasAddOns()
        For responses, this returns true if the service returned a value for the AddOns 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.

      • addOns

        public final List<AddOnRequest> addOns()

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

        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 hasAddOns() method.

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

      • ipAddressType

        public final IpAddressType ipAddressType()

        The IP address type for the instance.

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

        The default value is dualstack.

        If the service returns an enum value that is not available in the current SDK version, ipAddressType will return IpAddressType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipAddressTypeAsString().

        Returns:
        The IP address type for the instance.

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

        The default value is dualstack.

        See Also:
        IpAddressType

      • ipAddressTypeAsString

        public final String ipAddressTypeAsString()

        The IP address type for the instance.

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

        The default value is dualstack.

        If the service returns an enum value that is not available in the current SDK version, ipAddressType will return IpAddressType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipAddressTypeAsString().

        Returns:
        The IP address type for the instance.

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

        The default value is dualstack.

        See Also:
        IpAddressType

      • 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