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

Class CreateInstancesFromSnapshotRequest

    • 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 for your new instances.

        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 for your new instances.

      • hasAttachedDiskMapping

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

      • attachedDiskMapping

        public final Map<String,​List<DiskMap>> attachedDiskMapping()

        An object containing information about one or more disk mappings.

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

        Returns:
        An object containing information about one or more disk mappings.

      • availabilityZone

        public final String availabilityZone()

        The Availability Zone where you want to create your instances. Use the following formatting: 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 where you want to create your instances. Use the following formatting: 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.

      • instanceSnapshotName

        public final String instanceSnapshotName()

        The name of the instance snapshot on which you are basing your new instances. Use the get instance snapshots operation to return information about your existing snapshots.

        Constraint:

        • This parameter cannot be defined together with the source instance name parameter. The instance snapshot name and source instance name parameters are mutually exclusive.

        Returns:
        The name of the instance snapshot on which you are basing your new instances. Use the get instance snapshots operation to return information about your existing snapshots.

        Constraint:

        • This parameter cannot be defined together with the source instance name parameter. The instance snapshot name and source instance name parameters are mutually exclusive.

      • 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()

        You can create a launch script that configures a server with additional user data. For example, 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:
        You can create a launch script that configures a server with additional user data. For example, 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 for your key pair.

        Returns:
        The name for 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

      • sourceInstanceName

        public final String sourceInstanceName()

        The name of the source instance from which the source automatic snapshot was created.

        Constraints:

        • This parameter cannot be defined together with the instance snapshot name parameter. The source instance name and instance snapshot name parameters are mutually exclusive.

        • Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

        Returns:
        The name of the source instance from which the source automatic snapshot was created.

        Constraints:

        • This parameter cannot be defined together with the instance snapshot name parameter. The source instance name and instance snapshot name parameters are mutually exclusive.

        • Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

      • restoreDate

        public final String restoreDate()

        The date of the automatic snapshot to use for the new instance. Use the get auto snapshots operation to identify the dates of the available automatic snapshots.

        Constraints:

        • Must be specified in YYYY-MM-DD format.

        • This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive.

        • Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

        Returns:
        The date of the automatic snapshot to use for the new instance. Use the get auto snapshots operation to identify the dates of the available automatic snapshots.

        Constraints:

        • Must be specified in YYYY-MM-DD format.

        • This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive.

        • Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

      • useLatestRestorableAutoSnapshot

        public final Boolean useLatestRestorableAutoSnapshot()

        A Boolean value to indicate whether to use the latest available automatic snapshot.

        Constraints:

        • This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive.

        • Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

        Returns:
        A Boolean value to indicate whether to use the latest available automatic snapshot.

        Constraints:

        • This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive.

        • Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

      • 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