class Aws::Lightsail::Types::CreateInstancesFromSnapshotRequest
@note When making an API call, you may pass CreateInstancesFromSnapshotRequest
data as a hash: { instance_names: ["string"], # required attached_disk_mapping: { "ResourceName" => [ { original_disk_path: "NonEmptyString", new_disk_name: "ResourceName", }, ], }, availability_zone: "string", # required instance_snapshot_name: "ResourceName", bundle_id: "NonEmptyString", # required user_data: "string", key_pair_name: "ResourceName", tags: [ { key: "TagKey", value: "TagValue", }, ], add_ons: [ { add_on_type: "AutoSnapshot", # required, accepts AutoSnapshot auto_snapshot_add_on_request: { snapshot_time_of_day: "TimeOfDay", }, }, ], ip_address_type: "dualstack", # accepts dualstack, ipv4 source_instance_name: "string", restore_date: "string", use_latest_restorable_auto_snapshot: false, }
@!attribute [rw] instance_names
The names for your new instances. @return [Array<String>]
@!attribute [rw] attached_disk_mapping
An object containing information about one or more disk mappings. @return [Hash<String,Array<Types::DiskMap>>]
@!attribute [rw] availability_zone
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][1] operation. Be sure to add the `include Availability Zones` parameter to your request. [1]: http://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetRegions.html @return [String]
@!attribute [rw] instance_snapshot_name
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. ^ @return [String]
@!attribute [rw] bundle_id
The bundle of specification information for your virtual private server (or *instance*), including the pricing plan (e.g., `micro_1_0`). @return [String]
@!attribute [rw] user_data
You can create a launch script that configures a server with additional user data. For example, `apt-get -y update`. <note markdown="1"> 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][1]. </note> [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/compare-options-choose-lightsail-instance-image @return [String]
@!attribute [rw] key_pair_name
The name for your key pair. @return [String]
@!attribute [rw] 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. @return [Array<Types::Tag>]
@!attribute [rw] add_ons
An array of objects representing the add-ons to enable for the new instance. @return [Array<Types::AddOnRequest>]
@!attribute [rw] ip_address_type
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`. @return [String]
@!attribute [rw] source_instance_name
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][1]. [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots @return [String]
@!attribute [rw] restore_date
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][1]. [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots @return [String]
@!attribute [rw] use_latest_restorable_auto_snapshot
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][1]. [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots @return [Boolean]
@see docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateInstancesFromSnapshotRequest AWS API Documentation
Constants
- SENSITIVE