Interface CreateInstancesFromSnapshotRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateInstancesFromSnapshotRequest.Builder,
,CreateInstancesFromSnapshotRequest> LightsailRequest.Builder
,SdkBuilder<CreateInstancesFromSnapshotRequest.Builder,
,CreateInstancesFromSnapshotRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateInstancesFromSnapshotRequest
-
Method Summary
Modifier and TypeMethodDescriptionaddOns
(Collection<AddOnRequest> addOns) An array of objects representing the add-ons to enable for the new instance.addOns
(Consumer<AddOnRequest.Builder>... addOns) An array of objects representing the add-ons to enable for the new instance.addOns
(AddOnRequest... addOns) An array of objects representing the add-ons to enable for the new instance.attachedDiskMapping
(Map<String, ? extends Collection<DiskMap>> attachedDiskMapping) An object containing information about one or more disk mappings.availabilityZone
(String availabilityZone) The Availability Zone where you want to create your instances.The bundle of specification information for your virtual private server (or instance), including the pricing plan (micro_1_0
).instanceNames
(String... instanceNames) The names for your new instances.instanceNames
(Collection<String> instanceNames) The names for your new instances.instanceSnapshotName
(String instanceSnapshotName) The name of the instance snapshot on which you are basing your new instances.ipAddressType
(String ipAddressType) The IP address type for the instance.ipAddressType
(IpAddressType ipAddressType) The IP address type for the instance.keyPairName
(String keyPairName) The name for your key pair.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.restoreDate
(String restoreDate) The date of the automatic snapshot to use for the new instance.sourceInstanceName
(String sourceInstanceName) The name of the source instance from which the source automatic snapshot was created.tags
(Collection<Tag> tags) The tag keys and optional values to add to the resource during create.tags
(Consumer<Tag.Builder>... tags) The tag keys and optional values to add to the resource during create.The tag keys and optional values to add to the resource during create.useLatestRestorableAutoSnapshot
(Boolean useLatestRestorableAutoSnapshot) A Boolean value to indicate whether to use the latest available automatic snapshot.You can create a launch script that configures a server with additional user data.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.lightsail.model.LightsailRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
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 theinclude 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 theinclude Availability Zones
parameter to your request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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. Theinstance snapshot name
andsource 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. Theinstance snapshot name
andsource instance name
parameters are mutually exclusive.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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
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 useapt-get
, and FreeBSD usespkg
. 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 useapt-get
, and FreeBSD usespkg
. 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
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
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
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
The tag keys and optional values to add to the resource during create.
Use the
This is a convenience method that creates an instance of theTagResource
action to tag a resource after it's created.Tag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
An array of objects representing the add-ons to enable for the new instance.
This is a convenience method that creates an instance of theAddOnRequest.Builder
avoiding the need to create one manually viaAddOnRequest.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toaddOns(List<AddOnRequest>)
.- Parameters:
addOns
- a consumer that will call methods onAddOnRequest.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
ipAddressType
The IP address type for the instance.
The possible values are
ipv4
for IPv4 only, anddualstack
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, anddualstack
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
The IP address type for the instance.
The possible values are
ipv4
for IPv4 only, anddualstack
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, anddualstack
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:
-
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. Thesource instance name
andinstance 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. Thesource instance name
andinstance 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
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. Therestore date
anduse 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 theget 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. Therestore date
anduse 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. Theuse latest restorable auto snapshot
andrestore 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. Theuse latest restorable auto snapshot
andrestore 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.
-
-
overrideConfiguration
CreateInstancesFromSnapshotRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateInstancesFromSnapshotRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-