com.amazonaws.services.opsworks.model
Class CreateInstanceRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.opsworks.model.CreateInstanceRequest

All Implemented Interfaces:

Serializable

public class CreateInstanceRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the CreateInstance operation.

Creates an instance in a specified stack. For more information, see Adding an Instance to a Layer .

See Also:

AWSOpsWorks.createInstance(CreateInstanceRequest), Serialized Form

Constructor Summary

CreateInstanceRequest()

Method Summary

boolean	equals(Object obj)
String	getArchitecture() The instance architecture.
String	getAutoScalingType() The instance auto scaling type, which has three possible values: AlwaysRunning: A 24/7 instance, which is not affected by auto scaling. TimeBasedAutoScaling: A time-based auto scaling instance, which is started and stopped based on a specified schedule.
String	getAvailabilityZone() The instance Availability Zone.
String	getHostname() The instance host name.
String	getInstanceType() The instance type.
List<String>	getLayerIds() An array that contains the instance layer IDs.
String	getOs() The instance's operating system, which must be either "Amazon Linux" or "Ubuntu 12.04 LTS".
String	getRootDeviceType() The instance root device type.
String	getSshKeyName() The instance SSH key name.
String	getStackId() The stack ID.
int	hashCode()
void	setArchitecture(Architecture architecture) The instance architecture.
void	setArchitecture(String architecture) The instance architecture.
void	setAutoScalingType(AutoScalingType autoScalingType) The instance auto scaling type, which has three possible values: AlwaysRunning: A 24/7 instance, which is not affected by auto scaling. TimeBasedAutoScaling: A time-based auto scaling instance, which is started and stopped based on a specified schedule.
void	setAutoScalingType(String autoScalingType) The instance auto scaling type, which has three possible values: AlwaysRunning: A 24/7 instance, which is not affected by auto scaling. TimeBasedAutoScaling: A time-based auto scaling instance, which is started and stopped based on a specified schedule.
void	setAvailabilityZone(String availabilityZone) The instance Availability Zone.
void	setHostname(String hostname) The instance host name.
void	setInstanceType(String instanceType) The instance type.
void	setLayerIds(Collection<String> layerIds) An array that contains the instance layer IDs.
void	setOs(String os) The instance's operating system, which must be either "Amazon Linux" or "Ubuntu 12.04 LTS".
void	setRootDeviceType(RootDeviceType rootDeviceType) The instance root device type.
void	setRootDeviceType(String rootDeviceType) The instance root device type.
void	setSshKeyName(String sshKeyName) The instance SSH key name.
void	setStackId(String stackId) The stack ID.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateInstanceRequest	withArchitecture(Architecture architecture) The instance architecture.
CreateInstanceRequest	withArchitecture(String architecture) The instance architecture.
CreateInstanceRequest	withAutoScalingType(AutoScalingType autoScalingType) The instance auto scaling type, which has three possible values: AlwaysRunning: A 24/7 instance, which is not affected by auto scaling. TimeBasedAutoScaling: A time-based auto scaling instance, which is started and stopped based on a specified schedule.
CreateInstanceRequest	withAutoScalingType(String autoScalingType) The instance auto scaling type, which has three possible values: AlwaysRunning: A 24/7 instance, which is not affected by auto scaling. TimeBasedAutoScaling: A time-based auto scaling instance, which is started and stopped based on a specified schedule.
CreateInstanceRequest	withAvailabilityZone(String availabilityZone) The instance Availability Zone.
CreateInstanceRequest	withHostname(String hostname) The instance host name.
CreateInstanceRequest	withInstanceType(String instanceType) The instance type.
CreateInstanceRequest	withLayerIds(Collection<String> layerIds) An array that contains the instance layer IDs.
CreateInstanceRequest	withLayerIds(String... layerIds) An array that contains the instance layer IDs.
CreateInstanceRequest	withOs(String os) The instance's operating system, which must be either "Amazon Linux" or "Ubuntu 12.04 LTS".
CreateInstanceRequest	withRootDeviceType(RootDeviceType rootDeviceType) The instance root device type.
CreateInstanceRequest	withRootDeviceType(String rootDeviceType) The instance root device type.
CreateInstanceRequest	withSshKeyName(String sshKeyName) The instance SSH key name.
CreateInstanceRequest	withStackId(String stackId) The stack ID.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateInstanceRequest

public CreateInstanceRequest()

Method Detail

getStackId

public String getStackId()

The stack ID.

Returns:

The stack ID.

setStackId

public void setStackId(String stackId)

The stack ID.

Parameters:

stackId - The stack ID.

withStackId

public CreateInstanceRequest withStackId(String stackId)

The stack ID.

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

Parameters:

stackId - The stack ID.

Returns:

A reference to this updated object so that method calls can be chained together.

getLayerIds

public List<String> getLayerIds()

An array that contains the instance layer IDs.

Returns:

An array that contains the instance layer IDs.

setLayerIds

public void setLayerIds(Collection<String> layerIds)

An array that contains the instance layer IDs.

Parameters:

layerIds - An array that contains the instance layer IDs.

withLayerIds

public CreateInstanceRequest withLayerIds(String... layerIds)

An array that contains the instance layer IDs.

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

Parameters:

layerIds - An array that contains the instance layer IDs.

Returns:

A reference to this updated object so that method calls can be chained together.

withLayerIds

public CreateInstanceRequest withLayerIds(Collection<String> layerIds)

An array that contains the instance layer IDs.

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

Parameters:

layerIds - An array that contains the instance layer IDs.

Returns:

A reference to this updated object so that method calls can be chained together.

getInstanceType

public String getInstanceType()

The instance type. OpsWorks supports all instance types except Cluster Compute, Cluster GPU, and High Memory Cluster. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

Returns:

The instance type. OpsWorks supports all instance types except Cluster Compute, Cluster GPU, and High Memory Cluster. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

setInstanceType

public void setInstanceType(String instanceType)

The instance type. OpsWorks supports all instance types except Cluster Compute, Cluster GPU, and High Memory Cluster. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

Parameters:

instanceType - The instance type. OpsWorks supports all instance types except Cluster Compute, Cluster GPU, and High Memory Cluster. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

withInstanceType

public CreateInstanceRequest withInstanceType(String instanceType)

The instance type. OpsWorks supports all instance types except Cluster Compute, Cluster GPU, and High Memory Cluster. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

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

Parameters:

instanceType - The instance type. OpsWorks supports all instance types except Cluster Compute, Cluster GPU, and High Memory Cluster. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

Returns:

A reference to this updated object so that method calls can be chained together.

getAutoScalingType

public String getAutoScalingType()

The instance auto scaling type, which has three possible values:

• AlwaysRunning: A 24/7 instance, which is not affected by auto scaling.
• TimeBasedAutoScaling: A time-based auto scaling instance, which is started and stopped based on a specified schedule. To specify the schedule, call SetTimeBasedAutoScaling.
• LoadBasedAutoScaling: A load-based auto scaling instance, which is started and stopped based on load metrics. To use load-based auto scaling, you must enable it for the instance layer and configure the thresholds by calling SetLoadBasedAutoScaling.

Constraints:
Allowed Values: load, timer

Returns:

The instance auto scaling type, which has three possible values:

• AlwaysRunning: A 24/7 instance, which is not affected by auto scaling.
• TimeBasedAutoScaling: A time-based auto scaling instance, which is started and stopped based on a specified schedule. To specify the schedule, call SetTimeBasedAutoScaling.
• LoadBasedAutoScaling: A load-based auto scaling instance, which is started and stopped based on load metrics. To use load-based auto scaling, you must enable it for the instance layer and configure the thresholds by calling SetLoadBasedAutoScaling.

See Also:

AutoScalingType

setAutoScalingType

public void setAutoScalingType(String autoScalingType)

The instance auto scaling type, which has three possible values:

• AlwaysRunning: A 24/7 instance, which is not affected by auto scaling.
• TimeBasedAutoScaling: A time-based auto scaling instance, which is started and stopped based on a specified schedule. To specify the schedule, call SetTimeBasedAutoScaling.
• LoadBasedAutoScaling: A load-based auto scaling instance, which is started and stopped based on load metrics. To use load-based auto scaling, you must enable it for the instance layer and configure the thresholds by calling SetLoadBasedAutoScaling.

Constraints:
Allowed Values: load, timer

Parameters:

autoScalingType - The instance auto scaling type, which has three possible values:

• AlwaysRunning: A 24/7 instance, which is not affected by auto scaling.
• TimeBasedAutoScaling: A time-based auto scaling instance, which is started and stopped based on a specified schedule. To specify the schedule, call SetTimeBasedAutoScaling.
• LoadBasedAutoScaling: A load-based auto scaling instance, which is started and stopped based on load metrics. To use load-based auto scaling, you must enable it for the instance layer and configure the thresholds by calling SetLoadBasedAutoScaling.

See Also:

AutoScalingType

withAutoScalingType

public CreateInstanceRequest withAutoScalingType(String autoScalingType)

The instance auto scaling type, which has three possible values:

• AlwaysRunning: A 24/7 instance, which is not affected by auto scaling.
• TimeBasedAutoScaling: A time-based auto scaling instance, which is started and stopped based on a specified schedule. To specify the schedule, call SetTimeBasedAutoScaling.
• LoadBasedAutoScaling: A load-based auto scaling instance, which is started and stopped based on load metrics. To use load-based auto scaling, you must enable it for the instance layer and configure the thresholds by calling SetLoadBasedAutoScaling.

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

Constraints:
Allowed Values: load, timer

Parameters:

autoScalingType - The instance auto scaling type, which has three possible values:

• AlwaysRunning: A 24/7 instance, which is not affected by auto scaling.
• TimeBasedAutoScaling: A time-based auto scaling instance, which is started and stopped based on a specified schedule. To specify the schedule, call SetTimeBasedAutoScaling.
• LoadBasedAutoScaling: A load-based auto scaling instance, which is started and stopped based on load metrics. To use load-based auto scaling, you must enable it for the instance layer and configure the thresholds by calling SetLoadBasedAutoScaling.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

AutoScalingType

setAutoScalingType

public void setAutoScalingType(AutoScalingType autoScalingType)

The instance auto scaling type, which has three possible values:

• AlwaysRunning: A 24/7 instance, which is not affected by auto scaling.
• TimeBasedAutoScaling: A time-based auto scaling instance, which is started and stopped based on a specified schedule. To specify the schedule, call SetTimeBasedAutoScaling.
• LoadBasedAutoScaling: A load-based auto scaling instance, which is started and stopped based on load metrics. To use load-based auto scaling, you must enable it for the instance layer and configure the thresholds by calling SetLoadBasedAutoScaling.

Constraints:
Allowed Values: load, timer

Parameters:

autoScalingType - The instance auto scaling type, which has three possible values:

• AlwaysRunning: A 24/7 instance, which is not affected by auto scaling.
• TimeBasedAutoScaling: A time-based auto scaling instance, which is started and stopped based on a specified schedule. To specify the schedule, call SetTimeBasedAutoScaling.
• LoadBasedAutoScaling: A load-based auto scaling instance, which is started and stopped based on load metrics. To use load-based auto scaling, you must enable it for the instance layer and configure the thresholds by calling SetLoadBasedAutoScaling.

See Also:

AutoScalingType

withAutoScalingType

public CreateInstanceRequest withAutoScalingType(AutoScalingType autoScalingType)

The instance auto scaling type, which has three possible values:

• AlwaysRunning: A 24/7 instance, which is not affected by auto scaling.
• TimeBasedAutoScaling: A time-based auto scaling instance, which is started and stopped based on a specified schedule. To specify the schedule, call SetTimeBasedAutoScaling.
• LoadBasedAutoScaling: A load-based auto scaling instance, which is started and stopped based on load metrics. To use load-based auto scaling, you must enable it for the instance layer and configure the thresholds by calling SetLoadBasedAutoScaling.

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

Constraints:
Allowed Values: load, timer

Parameters:

autoScalingType - The instance auto scaling type, which has three possible values:

• AlwaysRunning: A 24/7 instance, which is not affected by auto scaling.
• TimeBasedAutoScaling: A time-based auto scaling instance, which is started and stopped based on a specified schedule. To specify the schedule, call SetTimeBasedAutoScaling.
• LoadBasedAutoScaling: A load-based auto scaling instance, which is started and stopped based on load metrics. To use load-based auto scaling, you must enable it for the instance layer and configure the thresholds by calling SetLoadBasedAutoScaling.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

AutoScalingType

getHostname

public String getHostname()

The instance host name.

Returns:

The instance host name.

setHostname

public void setHostname(String hostname)

The instance host name.

Parameters:

hostname - The instance host name.

withHostname

public CreateInstanceRequest withHostname(String hostname)

The instance host name.

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

Parameters:

hostname - The instance host name.

Returns:

A reference to this updated object so that method calls can be chained together.

getOs

public String getOs()

The instance's operating system, which must be either "Amazon Linux" or "Ubuntu 12.04 LTS".

Returns:

The instance's operating system, which must be either "Amazon Linux" or "Ubuntu 12.04 LTS".

setOs

public void setOs(String os)

The instance's operating system, which must be either "Amazon Linux" or "Ubuntu 12.04 LTS".

Parameters:

os - The instance's operating system, which must be either "Amazon Linux" or "Ubuntu 12.04 LTS".

withOs

public CreateInstanceRequest withOs(String os)

The instance's operating system, which must be either "Amazon Linux" or "Ubuntu 12.04 LTS".

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

Parameters:

os - The instance's operating system, which must be either "Amazon Linux" or "Ubuntu 12.04 LTS".

Returns:

A reference to this updated object so that method calls can be chained together.

getSshKeyName

public String getSshKeyName()

The instance SSH key name.

Returns:

The instance SSH key name.

setSshKeyName

public void setSshKeyName(String sshKeyName)

The instance SSH key name.

Parameters:

sshKeyName - The instance SSH key name.

withSshKeyName

public CreateInstanceRequest withSshKeyName(String sshKeyName)

The instance SSH key name.

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

Parameters:

sshKeyName - The instance SSH key name.

Returns:

A reference to this updated object so that method calls can be chained together.

getAvailabilityZone

public String getAvailabilityZone()

The instance Availability Zone. For more information, see Regions and Endpoints.

Returns:

The instance Availability Zone. For more information, see Regions and Endpoints.

setAvailabilityZone

public void setAvailabilityZone(String availabilityZone)

The instance Availability Zone. For more information, see Regions and Endpoints.

Parameters:

availabilityZone - The instance Availability Zone. For more information, see Regions and Endpoints.

withAvailabilityZone

public CreateInstanceRequest withAvailabilityZone(String availabilityZone)

The instance Availability Zone. For more information, see Regions and Endpoints.

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

Parameters:

availabilityZone - The instance Availability Zone. For more information, see Regions and Endpoints.

Returns:

A reference to this updated object so that method calls can be chained together.

getArchitecture

public String getArchitecture()

The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

Constraints:
Allowed Values: x86_64, i386

Returns:

The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

See Also:

Architecture

setArchitecture

public void setArchitecture(String architecture)

The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

Constraints:
Allowed Values: x86_64, i386

Parameters:

architecture - The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

See Also:

Architecture

withArchitecture

public CreateInstanceRequest withArchitecture(String architecture)

The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

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

Constraints:
Allowed Values: x86_64, i386

Parameters:

architecture - The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

Architecture

setArchitecture

public void setArchitecture(Architecture architecture)

The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

Constraints:
Allowed Values: x86_64, i386

Parameters:

architecture - The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

See Also:

Architecture

withArchitecture

public CreateInstanceRequest withArchitecture(Architecture architecture)

The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

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

Constraints:
Allowed Values: x86_64, i386

Parameters:

architecture - The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

Architecture

getRootDeviceType

public String getRootDeviceType()

The instance root device type. For more information, see Storage for the Root Device.

Constraints:
Allowed Values: ebs, instance-store

Returns:

The instance root device type. For more information, see Storage for the Root Device.

See Also:

RootDeviceType

setRootDeviceType

public void setRootDeviceType(String rootDeviceType)

The instance root device type. For more information, see Storage for the Root Device.

Constraints:
Allowed Values: ebs, instance-store

Parameters:

rootDeviceType - The instance root device type. For more information, see Storage for the Root Device.

See Also:

RootDeviceType

withRootDeviceType

public CreateInstanceRequest withRootDeviceType(String rootDeviceType)

The instance root device type. For more information, see Storage for the Root Device.

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

Constraints:
Allowed Values: ebs, instance-store

Parameters:

rootDeviceType - The instance root device type. For more information, see Storage for the Root Device.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

RootDeviceType

setRootDeviceType

public void setRootDeviceType(RootDeviceType rootDeviceType)

The instance root device type. For more information, see Storage for the Root Device.

Constraints:
Allowed Values: ebs, instance-store

Parameters:

rootDeviceType - The instance root device type. For more information, see Storage for the Root Device.

See Also:

RootDeviceType

withRootDeviceType

public CreateInstanceRequest withRootDeviceType(RootDeviceType rootDeviceType)

The instance root device type. For more information, see Storage for the Root Device.

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

Constraints:
Allowed Values: ebs, instance-store

Parameters:

rootDeviceType - The instance root device type. For more information, see Storage for the Root Device.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

RootDeviceType

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object