Paws::Lightsail::CreateInstances - Arguments for method CreateInstances on Paws::Lightsail


This class represents the parameters used for calling the method CreateInstances on the Amazon Lightsail service. Use the attributes of this class as arguments to method CreateInstances.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateInstances.


    my $lightsail = Paws->service('Lightsail');
    my $CreateInstancesResult = $lightsail->CreateInstances(
      AvailabilityZone => 'Mystring',
      BlueprintId      => 'MyNonEmptyString',
      BundleId         => 'MyNonEmptyString',
      InstanceNames    => [ 'Mystring', ... ],
      CustomImageName  => 'MyResourceName',      # OPTIONAL
      KeyPairName      => 'MyResourceName',      # OPTIONAL
      UserData         => 'Mystring',            # OPTIONAL

    # Results:
    my $Operations = $CreateInstancesResult->Operations;

    # Returns a L<Paws::Lightsail::CreateInstancesResult> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see


REQUIRED AvailabilityZone => Str

The Availability Zone in which to create your instance. Use the following format: 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.

REQUIRED BlueprintId => Str

The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0). Use the get blueprints operation to return a list of available images (or blueprints).

REQUIRED BundleId => Str

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

CustomImageName => Str

(Deprecated) The name for your custom image.

In releases prior to June 12, 2017, this parameter was ignored by the API. It is now deprecated.

REQUIRED InstanceNames => ArrayRef[Str|Undef]

The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for example: ["MyFirstInstance","MySecondInstance"]

KeyPairName => Str

The name of your key pair.

UserData => Str

A launch script you can create that configures a server with additional user data. For example, you might want to run 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 Dev Guide (


This class forms part of Paws, documenting arguments for method CreateInstances in Paws::Lightsail


The source code is located here:

Please report bugs to: