libZSservicesZSamazonka-lightsailZSamazonka-lightsail
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Lightsail.CreateInstancesFromSnapshot

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.

Synopsis

Creating a Request

data CreateInstancesFromSnapshot Source #

See: newCreateInstancesFromSnapshot smart constructor.

Constructors

CreateInstancesFromSnapshot' 

Fields

  • useLatestRestorableAutoSnapshot :: Maybe Bool

    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.
  • instanceSnapshotName :: Maybe Text

    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.
  • addOns :: Maybe [AddOnRequest]

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

  • userData :: Maybe Text

    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.

  • restoreDate :: Maybe Text

    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.
  • ipAddressType :: Maybe 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.

  • keyPairName :: Maybe Text

    The name for your key pair.

  • sourceInstanceName :: Maybe Text

    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.
  • attachedDiskMapping :: Maybe (HashMap Text [DiskMap])

    An object containing information about one or more disk mappings.

  • tags :: Maybe [Tag]

    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.

  • instanceNames :: [Text]

    The names for your new instances.

  • availabilityZone :: Text

    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.

  • bundleId :: Text

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

Instances

Instances details
Eq CreateInstancesFromSnapshot Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstancesFromSnapshot

Read CreateInstancesFromSnapshot Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstancesFromSnapshot

Show CreateInstancesFromSnapshot Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstancesFromSnapshot

Generic CreateInstancesFromSnapshot Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstancesFromSnapshot

Associated Types

type Rep CreateInstancesFromSnapshot :: Type -> Type #

NFData CreateInstancesFromSnapshot Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstancesFromSnapshot

Hashable CreateInstancesFromSnapshot Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstancesFromSnapshot

ToJSON CreateInstancesFromSnapshot Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstancesFromSnapshot

AWSRequest CreateInstancesFromSnapshot Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstancesFromSnapshot

ToHeaders CreateInstancesFromSnapshot Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstancesFromSnapshot

ToPath CreateInstancesFromSnapshot Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstancesFromSnapshot

ToQuery CreateInstancesFromSnapshot Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstancesFromSnapshot

type Rep CreateInstancesFromSnapshot Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstancesFromSnapshot

type Rep CreateInstancesFromSnapshot = D1 ('MetaData "CreateInstancesFromSnapshot" "Amazonka.Lightsail.CreateInstancesFromSnapshot" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" 'False) (C1 ('MetaCons "CreateInstancesFromSnapshot'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "useLatestRestorableAutoSnapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "instanceSnapshotName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "addOns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AddOnRequest])))) :*: (S1 ('MetaSel ('Just "userData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "restoreDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "ipAddressType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IpAddressType))))) :*: ((S1 ('MetaSel ('Just "keyPairName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "sourceInstanceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "attachedDiskMapping") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [DiskMap]))))) :*: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "instanceNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])) :*: (S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "bundleId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse CreateInstancesFromSnapshot Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstancesFromSnapshot

newCreateInstancesFromSnapshot Source #

Create a value of CreateInstancesFromSnapshot with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:useLatestRestorableAutoSnapshot:CreateInstancesFromSnapshot', createInstancesFromSnapshot_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.

$sel:instanceSnapshotName:CreateInstancesFromSnapshot', createInstancesFromSnapshot_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.

$sel:addOns:CreateInstancesFromSnapshot', createInstancesFromSnapshot_addOns - An array of objects representing the add-ons to enable for the new instance.

$sel:userData:CreateInstancesFromSnapshot', createInstancesFromSnapshot_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.

$sel:restoreDate:CreateInstancesFromSnapshot', createInstancesFromSnapshot_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.

$sel:ipAddressType:CreateInstancesFromSnapshot', createInstancesFromSnapshot_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.

$sel:keyPairName:CreateInstancesFromSnapshot', createInstancesFromSnapshot_keyPairName - The name for your key pair.

$sel:sourceInstanceName:CreateInstancesFromSnapshot', createInstancesFromSnapshot_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.

$sel:attachedDiskMapping:CreateInstancesFromSnapshot', createInstancesFromSnapshot_attachedDiskMapping - An object containing information about one or more disk mappings.

$sel:tags:CreateInstancesFromSnapshot', createInstancesFromSnapshot_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.

$sel:instanceNames:CreateInstancesFromSnapshot', createInstancesFromSnapshot_instanceNames - The names for your new instances.

$sel:availabilityZone:CreateInstancesFromSnapshot', createInstancesFromSnapshot_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.

$sel:bundleId:CreateInstancesFromSnapshot', createInstancesFromSnapshot_bundleId - The bundle of specification information for your virtual private server (or instance), including the pricing plan (e.g., micro_1_0).

Request Lenses

createInstancesFromSnapshot_useLatestRestorableAutoSnapshot :: Lens' CreateInstancesFromSnapshot (Maybe Bool) Source #

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.

createInstancesFromSnapshot_instanceSnapshotName :: Lens' CreateInstancesFromSnapshot (Maybe Text) Source #

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.

createInstancesFromSnapshot_addOns :: Lens' CreateInstancesFromSnapshot (Maybe [AddOnRequest]) Source #

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

createInstancesFromSnapshot_userData :: Lens' CreateInstancesFromSnapshot (Maybe Text) Source #

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.

createInstancesFromSnapshot_restoreDate :: Lens' CreateInstancesFromSnapshot (Maybe Text) Source #

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.

createInstancesFromSnapshot_ipAddressType :: Lens' CreateInstancesFromSnapshot (Maybe IpAddressType) Source #

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.

createInstancesFromSnapshot_sourceInstanceName :: Lens' CreateInstancesFromSnapshot (Maybe Text) Source #

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.

createInstancesFromSnapshot_attachedDiskMapping :: Lens' CreateInstancesFromSnapshot (Maybe (HashMap Text [DiskMap])) Source #

An object containing information about one or more disk mappings.

createInstancesFromSnapshot_tags :: Lens' CreateInstancesFromSnapshot (Maybe [Tag]) Source #

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.

createInstancesFromSnapshot_availabilityZone :: Lens' CreateInstancesFromSnapshot Text Source #

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.

createInstancesFromSnapshot_bundleId :: Lens' CreateInstancesFromSnapshot Text Source #

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

Destructuring the Response

data CreateInstancesFromSnapshotResponse Source #

Constructors

CreateInstancesFromSnapshotResponse' 

Fields

  • operations :: Maybe [Operation]

    An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq CreateInstancesFromSnapshotResponse Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstancesFromSnapshot

Read CreateInstancesFromSnapshotResponse Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstancesFromSnapshot

Show CreateInstancesFromSnapshotResponse Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstancesFromSnapshot

Generic CreateInstancesFromSnapshotResponse Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstancesFromSnapshot

NFData CreateInstancesFromSnapshotResponse Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstancesFromSnapshot

type Rep CreateInstancesFromSnapshotResponse Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstancesFromSnapshot

type Rep CreateInstancesFromSnapshotResponse = D1 ('MetaData "CreateInstancesFromSnapshotResponse" "Amazonka.Lightsail.CreateInstancesFromSnapshot" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" 'False) (C1 ('MetaCons "CreateInstancesFromSnapshotResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "operations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Operation])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateInstancesFromSnapshotResponse Source #

Create a value of CreateInstancesFromSnapshotResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:operations:CreateInstancesFromSnapshotResponse', createInstancesFromSnapshotResponse_operations - An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

$sel:httpStatus:CreateInstancesFromSnapshotResponse', createInstancesFromSnapshotResponse_httpStatus - The response's http status code.

Response Lenses

createInstancesFromSnapshotResponse_operations :: Lens' CreateInstancesFromSnapshotResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.