com.amazonaws.services.opsworks.model
Class UpdateInstanceRequest

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceRequest
      extended by com.amazonaws.services.opsworks.model.UpdateInstanceRequest
All Implemented Interfaces:
Serializable

public class UpdateInstanceRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the UpdateInstance operation.

Updates a specified instance.

Required Permissions : To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .

See Also:
AWSOpsWorks.updateInstance(UpdateInstanceRequest), Serialized Form

Constructor Summary
UpdateInstanceRequest()
           
 
Method Summary
 boolean equals(Object obj)
           
 String getAmiId()
          A custom AMI ID to be used to create the instance.
 String getArchitecture()
          The instance architecture.
 String getAutoScalingType()
          The instance's 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. LoadBasedAutoScaling: A load-based auto scaling instance, which is started and stopped based on load metrics.
 Boolean getEbsOptimized()
          Whether this is an Amazon EBS-optimized instance.
 String getHostname()
          The instance host name.
 Boolean getInstallUpdatesOnBoot()
          Whether to install operating system and package updates when the instance boots.
 String getInstanceId()
          The instance ID.
 String getInstanceType()
          The instance type.
 List<String> getLayerIds()
          The instance's layer IDs.
 String getOs()
          The instance operating system, which must be set to one of the following.
 String getSshKeyName()
          The instance SSH key name.
 int hashCode()
           
 Boolean isEbsOptimized()
          Whether this is an Amazon EBS-optimized instance.
 Boolean isInstallUpdatesOnBoot()
          Whether to install operating system and package updates when the instance boots.
 void setAmiId(String amiId)
          A custom AMI ID to be used to create the instance.
 void setArchitecture(Architecture architecture)
          The instance architecture.
 void setArchitecture(String architecture)
          The instance architecture.
 void setAutoScalingType(AutoScalingType autoScalingType)
          The instance's 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. LoadBasedAutoScaling: A load-based auto scaling instance, which is started and stopped based on load metrics.
 void setAutoScalingType(String autoScalingType)
          The instance's 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. LoadBasedAutoScaling: A load-based auto scaling instance, which is started and stopped based on load metrics.
 void setEbsOptimized(Boolean ebsOptimized)
          Whether this is an Amazon EBS-optimized instance.
 void setHostname(String hostname)
          The instance host name.
 void setInstallUpdatesOnBoot(Boolean installUpdatesOnBoot)
          Whether to install operating system and package updates when the instance boots.
 void setInstanceId(String instanceId)
          The instance ID.
 void setInstanceType(String instanceType)
          The instance type.
 void setLayerIds(Collection<String> layerIds)
          The instance's layer IDs.
 void setOs(String os)
          The instance operating system, which must be set to one of the following.
 void setSshKeyName(String sshKeyName)
          The instance SSH key name.
 String toString()
          Returns a string representation of this object; useful for testing and debugging.
 UpdateInstanceRequest withAmiId(String amiId)
          A custom AMI ID to be used to create the instance.
 UpdateInstanceRequest withArchitecture(Architecture architecture)
          The instance architecture.
 UpdateInstanceRequest withArchitecture(String architecture)
          The instance architecture.
 UpdateInstanceRequest withAutoScalingType(AutoScalingType autoScalingType)
          The instance's 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. LoadBasedAutoScaling: A load-based auto scaling instance, which is started and stopped based on load metrics.
 UpdateInstanceRequest withAutoScalingType(String autoScalingType)
          The instance's 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. LoadBasedAutoScaling: A load-based auto scaling instance, which is started and stopped based on load metrics.
 UpdateInstanceRequest withEbsOptimized(Boolean ebsOptimized)
          Whether this is an Amazon EBS-optimized instance.
 UpdateInstanceRequest withHostname(String hostname)
          The instance host name.
 UpdateInstanceRequest withInstallUpdatesOnBoot(Boolean installUpdatesOnBoot)
          Whether to install operating system and package updates when the instance boots.
 UpdateInstanceRequest withInstanceId(String instanceId)
          The instance ID.
 UpdateInstanceRequest withInstanceType(String instanceType)
          The instance type.
 UpdateInstanceRequest withLayerIds(Collection<String> layerIds)
          The instance's layer IDs.
 UpdateInstanceRequest withLayerIds(String... layerIds)
          The instance's layer IDs.
 UpdateInstanceRequest withOs(String os)
          The instance operating system, which must be set to one of the following.
 UpdateInstanceRequest withSshKeyName(String sshKeyName)
          The instance SSH key name.
 
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

UpdateInstanceRequest

public UpdateInstanceRequest()
Method Detail

getInstanceId

public String getInstanceId()
The instance ID.

Returns:
The instance ID.

setInstanceId

public void setInstanceId(String instanceId)
The instance ID.

Parameters:
instanceId - The instance ID.

withInstanceId

public UpdateInstanceRequest withInstanceId(String instanceId)
The instance ID.

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

Parameters:
instanceId - The instance ID.
Returns:
A reference to this updated object so that method calls can be chained together.

getLayerIds

public List<String> getLayerIds()
The instance's layer IDs.

Returns:
The instance's layer IDs.

setLayerIds

public void setLayerIds(Collection<String> layerIds)
The instance's layer IDs.

Parameters:
layerIds - The instance's layer IDs.

withLayerIds

public UpdateInstanceRequest withLayerIds(String... layerIds)
The instance's layer IDs.

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

Parameters:
layerIds - The instance's layer IDs.
Returns:
A reference to this updated object so that method calls can be chained together.

withLayerIds

public UpdateInstanceRequest withLayerIds(Collection<String> layerIds)
The instance's layer IDs.

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

Parameters:
layerIds - The instance's layer IDs.
Returns:
A reference to this updated object so that method calls can be chained together.

getInstanceType

public String getInstanceType()
The instance type. AWS 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. AWS 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. AWS 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. AWS 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 UpdateInstanceRequest withInstanceType(String instanceType)
The instance type. AWS 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. AWS 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's auto scaling type, which has three possible values:

Constraints:
Allowed Values: load, timer

Returns:
The instance's 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.
  • LoadBasedAutoScaling: A load-based auto scaling instance, which is started and stopped based on load metrics.
See Also:
AutoScalingType

setAutoScalingType

public void setAutoScalingType(String autoScalingType)
The instance's auto scaling type, which has three possible values:

Constraints:
Allowed Values: load, timer

Parameters:
autoScalingType - The instance's 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.
  • LoadBasedAutoScaling: A load-based auto scaling instance, which is started and stopped based on load metrics.
See Also:
AutoScalingType

withAutoScalingType

public UpdateInstanceRequest withAutoScalingType(String autoScalingType)
The instance's auto scaling type, which has three possible values:

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

Constraints:
Allowed Values: load, timer

Parameters:
autoScalingType - The instance's 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.
  • LoadBasedAutoScaling: A load-based auto scaling instance, which is started and stopped based on load metrics.
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's auto scaling type, which has three possible values:

Constraints:
Allowed Values: load, timer

Parameters:
autoScalingType - The instance's 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.
  • LoadBasedAutoScaling: A load-based auto scaling instance, which is started and stopped based on load metrics.
See Also:
AutoScalingType

withAutoScalingType

public UpdateInstanceRequest withAutoScalingType(AutoScalingType autoScalingType)
The instance's auto scaling type, which has three possible values:

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

Constraints:
Allowed Values: load, timer

Parameters:
autoScalingType - The instance's 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.
  • LoadBasedAutoScaling: A load-based auto scaling instance, which is started and stopped based on load metrics.
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 UpdateInstanceRequest 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 operating system, which must be set to one of the following.

The default option is Amazon Linux. If you set this parameter to Custom, you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. For more information on the standard operating systems, see Operating SystemsFor more information on how to use custom AMIs with OpsWorks, see Using Custom AMIs.

Returns:
The instance operating system, which must be set to one of the following.
  • Standard operating systems: Amazon Linux or Ubuntu 12.04 LTS
  • Custom AMIs: Custom

The default option is Amazon Linux. If you set this parameter to Custom, you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. For more information on the standard operating systems, see Operating SystemsFor more information on how to use custom AMIs with OpsWorks, see Using Custom AMIs.


setOs

public void setOs(String os)
The instance operating system, which must be set to one of the following.

The default option is Amazon Linux. If you set this parameter to Custom, you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. For more information on the standard operating systems, see Operating SystemsFor more information on how to use custom AMIs with OpsWorks, see Using Custom AMIs.

Parameters:
os - The instance operating system, which must be set to one of the following.
  • Standard operating systems: Amazon Linux or Ubuntu 12.04 LTS
  • Custom AMIs: Custom

The default option is Amazon Linux. If you set this parameter to Custom, you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. For more information on the standard operating systems, see Operating SystemsFor more information on how to use custom AMIs with OpsWorks, see Using Custom AMIs.


withOs

public UpdateInstanceRequest withOs(String os)
The instance operating system, which must be set to one of the following.

The default option is Amazon Linux. If you set this parameter to Custom, you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. For more information on the standard operating systems, see Operating SystemsFor more information on how to use custom AMIs with OpsWorks, see Using Custom AMIs.

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

Parameters:
os - The instance operating system, which must be set to one of the following.
  • Standard operating systems: Amazon Linux or Ubuntu 12.04 LTS
  • Custom AMIs: Custom

The default option is Amazon Linux. If you set this parameter to Custom, you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. For more information on the standard operating systems, see Operating SystemsFor more information on how to use custom AMIs with OpsWorks, see Using Custom AMIs.

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

getAmiId

public String getAmiId()
A custom AMI ID to be used to create the instance. The AMI should be based on one of the standard AWS OpsWorks APIs: Amazon Linux or Ubuntu 12.04 LTS. For more information, see Instances

Returns:
A custom AMI ID to be used to create the instance. The AMI should be based on one of the standard AWS OpsWorks APIs: Amazon Linux or Ubuntu 12.04 LTS. For more information, see Instances

setAmiId

public void setAmiId(String amiId)
A custom AMI ID to be used to create the instance. The AMI should be based on one of the standard AWS OpsWorks APIs: Amazon Linux or Ubuntu 12.04 LTS. For more information, see Instances

Parameters:
amiId - A custom AMI ID to be used to create the instance. The AMI should be based on one of the standard AWS OpsWorks APIs: Amazon Linux or Ubuntu 12.04 LTS. For more information, see Instances

withAmiId

public UpdateInstanceRequest withAmiId(String amiId)
A custom AMI ID to be used to create the instance. The AMI should be based on one of the standard AWS OpsWorks APIs: Amazon Linux or Ubuntu 12.04 LTS. For more information, see Instances

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

Parameters:
amiId - A custom AMI ID to be used to create the instance. The AMI should be based on one of the standard AWS OpsWorks APIs: Amazon Linux or Ubuntu 12.04 LTS. For more information, see Instances
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 UpdateInstanceRequest 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.

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 UpdateInstanceRequest 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 UpdateInstanceRequest 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

isInstallUpdatesOnBoot

public Boolean isInstallUpdatesOnBoot()
Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.

Returns:
Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.


setInstallUpdatesOnBoot

public void setInstallUpdatesOnBoot(Boolean installUpdatesOnBoot)
Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.

Parameters:
installUpdatesOnBoot - Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.


withInstallUpdatesOnBoot

public UpdateInstanceRequest withInstallUpdatesOnBoot(Boolean installUpdatesOnBoot)
Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.

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

Parameters:
installUpdatesOnBoot - Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.

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

getInstallUpdatesOnBoot

public Boolean getInstallUpdatesOnBoot()
Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.

Returns:
Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.


isEbsOptimized

public Boolean isEbsOptimized()
Whether this is an Amazon EBS-optimized instance.

Returns:
Whether this is an Amazon EBS-optimized instance.

setEbsOptimized

public void setEbsOptimized(Boolean ebsOptimized)
Whether this is an Amazon EBS-optimized instance.

Parameters:
ebsOptimized - Whether this is an Amazon EBS-optimized instance.

withEbsOptimized

public UpdateInstanceRequest withEbsOptimized(Boolean ebsOptimized)
Whether this is an Amazon EBS-optimized instance.

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

Parameters:
ebsOptimized - Whether this is an Amazon EBS-optimized instance.
Returns:
A reference to this updated object so that method calls can be chained together.

getEbsOptimized

public Boolean getEbsOptimized()
Whether this is an Amazon EBS-optimized instance.

Returns:
Whether this is an Amazon EBS-optimized instance.

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


Copyright © 2016. All rights reserved.