Create Instances From Snapshot
lightsail_create_instances_from_snapshot | R Documentation |
Creates one or more new instances from a manual or automatic snapshot of an instance¶
Description¶
Creates one or more new instances from a manual or automatic snapshot of an instance.
The create instances from snapshot
operation supports tag-based access
control via request tags and resource tags applied to the resource
identified by instance snapshot name
. For more information, see the
Amazon Lightsail Developer
Guide.
Usage¶
lightsail_create_instances_from_snapshot(instanceNames,
attachedDiskMapping, availabilityZone, instanceSnapshotName, bundleId,
userData, keyPairName, tags, addOns, ipAddressType, sourceInstanceName,
restoreDate, useLatestRestorableAutoSnapshot)
Arguments¶
instanceNames
[required] The names for your new instances.
attachedDiskMapping
An object containing information about one or more disk mappings.
availabilityZone
[required] 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.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.
bundleId
[required] The bundle of specification information for your virtual private server (or instance), including the pricing plan (
micro_x_x
).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.keyPairName
The name for your key pair.
tags
The tag keys and optional values to add to the resource during create.
Use the
tag_resource
action to tag a resource after it's created.addOns
An array of objects representing the add-ons to enable for the new instance.
ipAddressType
The IP address type for the instance.
The possible values are
ipv4
for IPv4 only,ipv6
for IPv6 only, anddualstack
for IPv4 and IPv6.The default value is
dualstack
.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.
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.
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.
Value¶
A list with the following syntax:
list(
operations = list(
list(
id = "string",
resourceName = "string",
resourceType = "ContainerService"|"Instance"|"StaticIp"|"KeyPair"|"InstanceSnapshot"|"Domain"|"PeeredVpc"|"LoadBalancer"|"LoadBalancerTlsCertificate"|"Disk"|"DiskSnapshot"|"RelationalDatabase"|"RelationalDatabaseSnapshot"|"ExportSnapshotRecord"|"CloudFormationStackRecord"|"Alarm"|"ContactMethod"|"Distribution"|"Certificate"|"Bucket",
createdAt = as.POSIXct(
"2015-01-01"
),
location = list(
availabilityZone = "string",
regionName = "us-east-1"|"us-east-2"|"us-west-1"|"us-west-2"|"eu-west-1"|"eu-west-2"|"eu-west-3"|"eu-central-1"|"ca-central-1"|"ap-south-1"|"ap-southeast-1"|"ap-southeast-2"|"ap-northeast-1"|"ap-northeast-2"|"eu-north-1"
),
isTerminal = TRUE|FALSE,
operationDetails = "string",
operationType = "DeleteKnownHostKeys"|"DeleteInstance"|"CreateInstance"|"StopInstance"|"StartInstance"|"RebootInstance"|"OpenInstancePublicPorts"|"PutInstancePublicPorts"|"CloseInstancePublicPorts"|"AllocateStaticIp"|"ReleaseStaticIp"|"AttachStaticIp"|"DetachStaticIp"|"UpdateDomainEntry"|"DeleteDomainEntry"|"CreateDomain"|"DeleteDomain"|"CreateInstanceSnapshot"|"DeleteInstanceSnapshot"|"CreateInstancesFromSnapshot"|"CreateLoadBalancer"|"DeleteLoadBalancer"|"AttachInstancesToLoadBalancer"|"DetachInstancesFromLoadBalancer"|"UpdateLoadBalancerAttribute"|"CreateLoadBalancerTlsCertificate"|"DeleteLoadBalancerTlsCertificate"|"AttachLoadBalancerTlsCertificate"|"CreateDisk"|"DeleteDisk"|"AttachDisk"|"DetachDisk"|"CreateDiskSnapshot"|"DeleteDiskSnapshot"|"CreateDiskFromSnapshot"|"CreateRelationalDatabase"|"UpdateRelationalDatabase"|"DeleteRelationalDatabase"|"CreateRelationalDatabaseFromSnapshot"|"CreateRelationalDatabaseSnapshot"|"DeleteRelationalDatabaseSnapshot"|"UpdateRelationalDatabaseParameters"|"StartRelationalDatabase"|"RebootRelationalDatabase"|"StopRelationalDatabase"|"EnableAddOn"|"DisableAddOn"|"PutAlarm"|"GetAlarms"|"DeleteAlarm"|"TestAlarm"|"CreateContactMethod"|"GetContactMethods"|"SendContactMethodVerification"|"DeleteContactMethod"|"CreateDistribution"|"UpdateDistribution"|"DeleteDistribution"|"ResetDistributionCache"|"AttachCertificateToDistribution"|"DetachCertificateFromDistribution"|"UpdateDistributionBundle"|"SetIpAddressType"|"CreateCertificate"|"DeleteCertificate"|"CreateContainerService"|"UpdateContainerService"|"DeleteContainerService"|"CreateContainerServiceDeployment"|"CreateContainerServiceRegistryLogin"|"RegisterContainerImage"|"DeleteContainerImage"|"CreateBucket"|"DeleteBucket"|"CreateBucketAccessKey"|"DeleteBucketAccessKey"|"UpdateBucketBundle"|"UpdateBucket"|"SetResourceAccessForBucket"|"UpdateInstanceMetadataOptions"|"StartGUISession"|"StopGUISession"|"SetupInstanceHttps",
status = "NotStarted"|"Started"|"Failed"|"Completed"|"Succeeded",
statusChangedAt = as.POSIXct(
"2015-01-01"
),
errorCode = "string",
errorDetails = "string"
)
)
)
Request syntax¶
svc$create_instances_from_snapshot(
instanceNames = list(
"string"
),
attachedDiskMapping = list(
list(
list(
originalDiskPath = "string",
newDiskName = "string"
)
)
),
availabilityZone = "string",
instanceSnapshotName = "string",
bundleId = "string",
userData = "string",
keyPairName = "string",
tags = list(
list(
key = "string",
value = "string"
)
),
addOns = list(
list(
addOnType = "AutoSnapshot"|"StopInstanceOnIdle",
autoSnapshotAddOnRequest = list(
snapshotTimeOfDay = "string"
),
stopInstanceOnIdleRequest = list(
threshold = "string",
duration = "string"
)
)
),
ipAddressType = "dualstack"|"ipv4"|"ipv6",
sourceInstanceName = "string",
restoreDate = "string",
useLatestRestorableAutoSnapshot = TRUE|FALSE
)