amazonka-lightsail-2.0: Amazon Lightsail SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Lightsail.CreateInstances

Description

Creates one or more Amazon Lightsail instances.

The create instances operation supports tag-based access control via request tags. For more information, see the Lightsail Developer Guide.

Synopsis

Creating a Request

data CreateInstances Source #

See: newCreateInstances smart constructor.

Constructors

CreateInstances' 

Fields

  • addOns :: Maybe [AddOnRequest]

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

  • customImageName :: Maybe Text

    (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.

  • 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 of your key pair.

  • 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.

  • userData :: Maybe Text

    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 Amazon Lightsail Developer Guide.

  • instanceNames :: [Text]

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

  • availabilityZone :: Text

    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.

  • blueprintId :: Text

    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).

    Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.

  • 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
ToJSON CreateInstances Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstances

ToHeaders CreateInstances Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstances

ToPath CreateInstances Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstances

ToQuery CreateInstances Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstances

AWSRequest CreateInstances Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstances

Associated Types

type AWSResponse CreateInstances #

Generic CreateInstances Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstances

Associated Types

type Rep CreateInstances :: Type -> Type #

Read CreateInstances Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstances

Show CreateInstances Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstances

NFData CreateInstances Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstances

Methods

rnf :: CreateInstances -> () #

Eq CreateInstances Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstances

Hashable CreateInstances Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstances

type AWSResponse CreateInstances Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstances

type Rep CreateInstances Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstances

newCreateInstances Source #

Create a value of CreateInstances 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:

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

$sel:customImageName:CreateInstances', createInstances_customImageName - (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.

CreateInstances, createInstances_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.

CreateInstances, createInstances_keyPairName - The name of your key pair.

CreateInstances, createInstances_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.

CreateInstances, createInstances_userData - 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 Amazon Lightsail Developer Guide.

$sel:instanceNames:CreateInstances', createInstances_instanceNames - The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for example: ["MyFirstInstance","MySecondInstance"]

CreateInstances, createInstances_availabilityZone - 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.

CreateInstances, createInstances_blueprintId - 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).

Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.

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

Request Lenses

createInstances_addOns :: Lens' CreateInstances (Maybe [AddOnRequest]) Source #

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

createInstances_customImageName :: Lens' CreateInstances (Maybe Text) Source #

(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.

createInstances_ipAddressType :: Lens' CreateInstances (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.

createInstances_tags :: Lens' CreateInstances (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.

createInstances_userData :: Lens' CreateInstances (Maybe Text) Source #

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 Amazon Lightsail Developer Guide.

createInstances_instanceNames :: Lens' CreateInstances [Text] Source #

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

createInstances_availabilityZone :: Lens' CreateInstances Text Source #

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.

createInstances_blueprintId :: Lens' CreateInstances Text Source #

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).

Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.

createInstances_bundleId :: Lens' CreateInstances 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 CreateInstancesResponse Source #

See: newCreateInstancesResponse smart constructor.

Constructors

CreateInstancesResponse' 

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
Generic CreateInstancesResponse Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstances

Associated Types

type Rep CreateInstancesResponse :: Type -> Type #

Read CreateInstancesResponse Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstances

Show CreateInstancesResponse Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstances

NFData CreateInstancesResponse Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstances

Methods

rnf :: CreateInstancesResponse -> () #

Eq CreateInstancesResponse Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstances

type Rep CreateInstancesResponse Source # 
Instance details

Defined in Amazonka.Lightsail.CreateInstances

type Rep CreateInstancesResponse = D1 ('MetaData "CreateInstancesResponse" "Amazonka.Lightsail.CreateInstances" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "CreateInstancesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "operations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Operation])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateInstancesResponse Source #

Create a value of CreateInstancesResponse 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:CreateInstancesResponse', createInstancesResponse_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:CreateInstancesResponse', createInstancesResponse_httpStatus - The response's http status code.

Response Lenses

createInstancesResponse_operations :: Lens' CreateInstancesResponse (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.