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

Interface CreateInstancesFromSnapshotRequest.Builder

    • Method Detail

      • instanceNames

        CreateInstancesFromSnapshotRequest.Builder instanceNames​(Collection<String> instanceNames)

        The names for your new instances.

        Parameters:
        instanceNames - The names for your new instances.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • instanceNames

        CreateInstancesFromSnapshotRequest.Builder instanceNames​(String... instanceNames)

        The names for your new instances.

        Parameters:
        instanceNames - The names for your new instances.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • attachedDiskMapping

        CreateInstancesFromSnapshotRequest.Builder attachedDiskMapping​(Map<String,​? extends Collection<DiskMap>> attachedDiskMapping)

        An object containing information about one or more disk mappings.

        Parameters:
        attachedDiskMapping - An object containing information about one or more disk mappings.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • availabilityZone

        CreateInstancesFromSnapshotRequest.Builder availabilityZone​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • instanceSnapshotName

        CreateInstancesFromSnapshotRequest.Builder instanceSnapshotName​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • bundleId

        CreateInstancesFromSnapshotRequest.Builder bundleId​(String bundleId)

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

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

      • userData

        CreateInstancesFromSnapshotRequest.Builder userData​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • keyPairName

        CreateInstancesFromSnapshotRequest.Builder keyPairName​(String keyPairName)

        The name for your key pair.

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

      • tags

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

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

        CreateInstancesFromSnapshotRequest.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).

        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:
        #tags(java.util.Collection)

      • addOns

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

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

      • ipAddressType

        CreateInstancesFromSnapshotRequest.Builder ipAddressType​(String 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.

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

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

      • ipAddressType

        CreateInstancesFromSnapshotRequest.Builder ipAddressType​(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.

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

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

      • sourceInstanceName

        CreateInstancesFromSnapshotRequest.Builder sourceInstanceName​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • restoreDate

        CreateInstancesFromSnapshotRequest.Builder restoreDate​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • useLatestRestorableAutoSnapshot

        CreateInstancesFromSnapshotRequest.Builder useLatestRestorableAutoSnapshot​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.