com.amazonaws.services.lightsail.model

Class CreateInstancesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.lightsail.model.CreateInstancesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateInstancesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateInstancesRequest()

Method Summary

Modifier and Type	Method and Description
CreateInstancesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAvailabilityZone() The Availability Zone in which to create your instance.
String	getBlueprintId() The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0).
String	getBundleId() The bundle of specification information for your virtual private server (or instance), including the pricing plan (e.g., micro_1_0).
String	getCustomImageName() Deprecated.
List<String>	getInstanceNames() The names to use for your new Lightsail instances.
String	getKeyPairName() The name of your key pair.
String	getUserData() A launch script you can create that configures a server with additional user data.
int	hashCode()
void	setAvailabilityZone(String availabilityZone) The Availability Zone in which to create your instance.
void	setBlueprintId(String blueprintId) The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0).
void	setBundleId(String bundleId) The bundle of specification information for your virtual private server (or instance), including the pricing plan (e.g., micro_1_0).
void	setCustomImageName(String customImageName) Deprecated.
void	setInstanceNames(Collection<String> instanceNames) The names to use for your new Lightsail instances.
void	setKeyPairName(String keyPairName) The name of your key pair.
void	setUserData(String userData) A launch script you can create that configures a server with additional user data.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateInstancesRequest	withAvailabilityZone(String availabilityZone) The Availability Zone in which to create your instance.
CreateInstancesRequest	withBlueprintId(String blueprintId) The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0).
CreateInstancesRequest	withBundleId(String bundleId) The bundle of specification information for your virtual private server (or instance), including the pricing plan (e.g., micro_1_0).
CreateInstancesRequest	withCustomImageName(String customImageName) Deprecated.
CreateInstancesRequest	withInstanceNames(Collection<String> instanceNames) The names to use for your new Lightsail instances.
CreateInstancesRequest	withInstanceNames(String... instanceNames) The names to use for your new Lightsail instances.
CreateInstancesRequest	withKeyPairName(String keyPairName) The name of your key pair.
CreateInstancesRequest	withUserData(String userData) A launch script you can create that configures a server with additional user data.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateInstancesRequest

public CreateInstancesRequest()

Method Detail

getInstanceNames

public List<String> getInstanceNames()

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

Returns:

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

setInstanceNames

public void setInstanceNames(Collection<String> instanceNames)

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

Parameters:

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

withInstanceNames

public CreateInstancesRequest withInstanceNames(String... instanceNames)

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

NOTE: This method appends the values to the existing list (if any). Use setInstanceNames(java.util.Collection) or withInstanceNames(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withInstanceNames

public CreateInstancesRequest withInstanceNames(Collection<String> instanceNames)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setAvailabilityZone

public void setAvailabilityZone(String availabilityZone)

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

Parameters:

availabilityZone - The Availability Zone in which to create your instance. Use the following format: us-east-1a (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.

getAvailabilityZone

public String getAvailabilityZone()

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

Returns:

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

withAvailabilityZone

public CreateInstancesRequest withAvailabilityZone(String availabilityZone)

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

Parameters:

availabilityZone - The Availability Zone in which to create your instance. Use the following format: us-east-1a (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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCustomImageName

@Deprecated
public void setCustomImageName(String customImageName)

Deprecated.

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

Parameters:

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.

getCustomImageName

@Deprecated
public String getCustomImageName()

Deprecated.

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

Returns:

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

withCustomImageName

@Deprecated
public CreateInstancesRequest withCustomImageName(String customImageName)

Deprecated.

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

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setBlueprintId

public void setBlueprintId(String 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).

Parameters:

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

getBlueprintId

public String getBlueprintId()

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

Returns:

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

withBlueprintId

public CreateInstancesRequest withBlueprintId(String 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).

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setBundleId

public void setBundleId(String bundleId)

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

Parameters:

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

getBundleId

public String getBundleId()

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

Returns:

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

withBundleId

public CreateInstancesRequest withBundleId(String bundleId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setUserData

public void setUserData(String 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 Dev Guide.

Parameters:

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 Dev Guide.

getUserData

public String getUserData()

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.

Returns:

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.

withUserData

public CreateInstancesRequest withUserData(String 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 Dev Guide.

Parameters:

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 Dev Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

setKeyPairName

public void setKeyPairName(String keyPairName)

The name of your key pair.

Parameters:

keyPairName - The name of your key pair.

getKeyPairName

public String getKeyPairName()

The name of your key pair.

Returns:

The name of your key pair.

withKeyPairName

public CreateInstancesRequest withKeyPairName(String keyPairName)

The name of your key pair.

Parameters:

keyPairName - The name of your key pair.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateInstancesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()