com.amazonaws.services.opsworks.model
Class UpdateLayerRequest

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

All Implemented Interfaces:

Serializable

public class UpdateLayerRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the UpdateLayer operation.

Updates a specified layer.

See Also:

AWSOpsWorks.updateLayer(UpdateLayerRequest), Serialized Form

Constructor Summary

UpdateLayerRequest()

Method Summary

UpdateLayerRequest	addAttributesEntry(String key, String value) One or more user-defined key/value pairs to be added to the stack attributes bag.
UpdateLayerRequest	clearAttributesEntries() Removes all the entries added into Attributes.
boolean	equals(Object obj)
Map<String,String>	getAttributes() One or more user-defined key/value pairs to be added to the stack attributes bag.
Boolean	getAutoAssignElasticIps() Whether to automatically assign an Elastic IP address to the layer.
String	getCustomInstanceProfileArn() The ARN of an IAM profile to be used for all of the layer's EC2 instances.
Recipes	getCustomRecipes() A LayerCustomRecipes object that specifies the layer's custom recipes.
List<String>	getCustomSecurityGroupIds() An array containing the layer's custom security group IDs.
Boolean	getEnableAutoHealing() Whether to disable auto healing for the layer.
Boolean	getInstallUpdatesOnBoot() Whether to install operating system and package updates when the instance boots.
String	getLayerId() The layer ID.
String	getName() The layer name, which is used by the console.
List<String>	getPackages() An array of Package objects that describe the layer's packages.
String	getShortname() The layer short name, which is used internally by AWS OpsWorksand by Chef.
List<VolumeConfiguration>	getVolumeConfigurations() A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
int	hashCode()
Boolean	isAutoAssignElasticIps() Whether to automatically assign an Elastic IP address to the layer.
Boolean	isEnableAutoHealing() Whether to disable auto healing for the layer.
Boolean	isInstallUpdatesOnBoot() Whether to install operating system and package updates when the instance boots.
void	setAttributes(Map<String,String> attributes) One or more user-defined key/value pairs to be added to the stack attributes bag.
void	setAutoAssignElasticIps(Boolean autoAssignElasticIps) Whether to automatically assign an Elastic IP address to the layer.
void	setCustomInstanceProfileArn(String customInstanceProfileArn) The ARN of an IAM profile to be used for all of the layer's EC2 instances.
void	setCustomRecipes(Recipes customRecipes) A LayerCustomRecipes object that specifies the layer's custom recipes.
void	setCustomSecurityGroupIds(Collection<String> customSecurityGroupIds) An array containing the layer's custom security group IDs.
void	setEnableAutoHealing(Boolean enableAutoHealing) Whether to disable auto healing for the layer.
void	setInstallUpdatesOnBoot(Boolean installUpdatesOnBoot) Whether to install operating system and package updates when the instance boots.
void	setLayerId(String layerId) The layer ID.
void	setName(String name) The layer name, which is used by the console.
void	setPackages(Collection<String> packages) An array of Package objects that describe the layer's packages.
void	setShortname(String shortname) The layer short name, which is used internally by AWS OpsWorksand by Chef.
void	setVolumeConfigurations(Collection<VolumeConfiguration> volumeConfigurations) A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UpdateLayerRequest	withAttributes(Map<String,String> attributes) One or more user-defined key/value pairs to be added to the stack attributes bag.
UpdateLayerRequest	withAutoAssignElasticIps(Boolean autoAssignElasticIps) Whether to automatically assign an Elastic IP address to the layer.
UpdateLayerRequest	withCustomInstanceProfileArn(String customInstanceProfileArn) The ARN of an IAM profile to be used for all of the layer's EC2 instances.
UpdateLayerRequest	withCustomRecipes(Recipes customRecipes) A LayerCustomRecipes object that specifies the layer's custom recipes.
UpdateLayerRequest	withCustomSecurityGroupIds(Collection<String> customSecurityGroupIds) An array containing the layer's custom security group IDs.
UpdateLayerRequest	withCustomSecurityGroupIds(String... customSecurityGroupIds) An array containing the layer's custom security group IDs.
UpdateLayerRequest	withEnableAutoHealing(Boolean enableAutoHealing) Whether to disable auto healing for the layer.
UpdateLayerRequest	withInstallUpdatesOnBoot(Boolean installUpdatesOnBoot) Whether to install operating system and package updates when the instance boots.
UpdateLayerRequest	withLayerId(String layerId) The layer ID.
UpdateLayerRequest	withName(String name) The layer name, which is used by the console.
UpdateLayerRequest	withPackages(Collection<String> packages) An array of Package objects that describe the layer's packages.
UpdateLayerRequest	withPackages(String... packages) An array of Package objects that describe the layer's packages.
UpdateLayerRequest	withShortname(String shortname) The layer short name, which is used internally by AWS OpsWorksand by Chef.
UpdateLayerRequest	withVolumeConfigurations(Collection<VolumeConfiguration> volumeConfigurations) A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
UpdateLayerRequest	withVolumeConfigurations(VolumeConfiguration... volumeConfigurations) A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

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

UpdateLayerRequest

public UpdateLayerRequest()

Method Detail

getLayerId

public String getLayerId()

The layer ID.

Returns:

The layer ID.

setLayerId

public void setLayerId(String layerId)

The layer ID.

Parameters:

layerId - The layer ID.

withLayerId

public UpdateLayerRequest withLayerId(String layerId)

The layer ID.

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

Parameters:

layerId - The layer ID.

Returns:

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

getName

public String getName()

The layer name, which is used by the console.

Returns:

The layer name, which is used by the console.

setName

public void setName(String name)

The layer name, which is used by the console.

Parameters:

name - The layer name, which is used by the console.

withName

public UpdateLayerRequest withName(String name)

The layer name, which is used by the console.

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

Parameters:

name - The layer name, which is used by the console.

Returns:

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

getShortname

public String getShortname()

The layer short name, which is used internally by AWS OpsWorksand by Chef. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters and must be in the following format: /\A[a-z0-9\-\_\.]+\Z/.

Returns:

The layer short name, which is used internally by AWS OpsWorksand by Chef. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters and must be in the following format: /\A[a-z0-9\-\_\.]+\Z/.

setShortname

public void setShortname(String shortname)

The layer short name, which is used internally by AWS OpsWorksand by Chef. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters and must be in the following format: /\A[a-z0-9\-\_\.]+\Z/.

Parameters:

shortname - The layer short name, which is used internally by AWS OpsWorksand by Chef. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters and must be in the following format: /\A[a-z0-9\-\_\.]+\Z/.

withShortname

public UpdateLayerRequest withShortname(String shortname)

The layer short name, which is used internally by AWS OpsWorksand by Chef. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters and must be in the following format: /\A[a-z0-9\-\_\.]+\Z/.

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

Parameters:

shortname - The layer short name, which is used internally by AWS OpsWorksand by Chef. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters and must be in the following format: /\A[a-z0-9\-\_\.]+\Z/.

Returns:

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

getAttributes

public Map<String,String> getAttributes()

One or more user-defined key/value pairs to be added to the stack attributes bag.

Returns:

One or more user-defined key/value pairs to be added to the stack attributes bag.

setAttributes

public void setAttributes(Map<String,String> attributes)

One or more user-defined key/value pairs to be added to the stack attributes bag.

Parameters:

attributes - One or more user-defined key/value pairs to be added to the stack attributes bag.

withAttributes

public UpdateLayerRequest withAttributes(Map<String,String> attributes)

One or more user-defined key/value pairs to be added to the stack attributes bag.

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

Parameters:

attributes - One or more user-defined key/value pairs to be added to the stack attributes bag.

Returns:

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

addAttributesEntry

public UpdateLayerRequest addAttributesEntry(String key,
                                             String value)

One or more user-defined key/value pairs to be added to the stack attributes bag.

The method adds a new key-value pair into Attributes parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into Attributes.

value - The corresponding value of the entry to be added into Attributes.

clearAttributesEntries

public UpdateLayerRequest clearAttributesEntries()

Removes all the entries added into Attributes.

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

getCustomInstanceProfileArn

public String getCustomInstanceProfileArn()

The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

Returns:

The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

setCustomInstanceProfileArn

public void setCustomInstanceProfileArn(String customInstanceProfileArn)

The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

Parameters:

customInstanceProfileArn - The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

withCustomInstanceProfileArn

public UpdateLayerRequest withCustomInstanceProfileArn(String customInstanceProfileArn)

The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

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

Parameters:

customInstanceProfileArn - The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

Returns:

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

getCustomSecurityGroupIds

public List<String> getCustomSecurityGroupIds()

An array containing the layer's custom security group IDs.

Returns:

An array containing the layer's custom security group IDs.

setCustomSecurityGroupIds

public void setCustomSecurityGroupIds(Collection<String> customSecurityGroupIds)

An array containing the layer's custom security group IDs.

Parameters:

customSecurityGroupIds - An array containing the layer's custom security group IDs.

withCustomSecurityGroupIds

public UpdateLayerRequest withCustomSecurityGroupIds(String... customSecurityGroupIds)

An array containing the layer's custom security group IDs.

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

Parameters:

customSecurityGroupIds - An array containing the layer's custom security group IDs.

Returns:

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

withCustomSecurityGroupIds

public UpdateLayerRequest withCustomSecurityGroupIds(Collection<String> customSecurityGroupIds)

An array containing the layer's custom security group IDs.

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

Parameters:

customSecurityGroupIds - An array containing the layer's custom security group IDs.

Returns:

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

getPackages

public List<String> getPackages()

An array of Package objects that describe the layer's packages.

Returns:

An array of Package objects that describe the layer's packages.

setPackages

public void setPackages(Collection<String> packages)

An array of Package objects that describe the layer's packages.

Parameters:

packages - An array of Package objects that describe the layer's packages.

withPackages

public UpdateLayerRequest withPackages(String... packages)

An array of Package objects that describe the layer's packages.

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

Parameters:

packages - An array of Package objects that describe the layer's packages.

Returns:

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

withPackages

public UpdateLayerRequest withPackages(Collection<String> packages)

An array of Package objects that describe the layer's packages.

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

Parameters:

packages - An array of Package objects that describe the layer's packages.

Returns:

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

getVolumeConfigurations

public List<VolumeConfiguration> getVolumeConfigurations()

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

Returns:

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

setVolumeConfigurations

public void setVolumeConfigurations(Collection<VolumeConfiguration> volumeConfigurations)

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

Parameters:

volumeConfigurations - A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

withVolumeConfigurations

public UpdateLayerRequest withVolumeConfigurations(VolumeConfiguration... volumeConfigurations)

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

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

Parameters:

volumeConfigurations - A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

Returns:

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

withVolumeConfigurations

public UpdateLayerRequest withVolumeConfigurations(Collection<VolumeConfiguration> volumeConfigurations)

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

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

Parameters:

volumeConfigurations - A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

Returns:

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

isEnableAutoHealing

public Boolean isEnableAutoHealing()

Whether to disable auto healing for the layer.

Returns:

Whether to disable auto healing for the layer.

setEnableAutoHealing

public void setEnableAutoHealing(Boolean enableAutoHealing)

Whether to disable auto healing for the layer.

Parameters:

enableAutoHealing - Whether to disable auto healing for the layer.

withEnableAutoHealing

public UpdateLayerRequest withEnableAutoHealing(Boolean enableAutoHealing)

Whether to disable auto healing for the layer.

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

Parameters:

enableAutoHealing - Whether to disable auto healing for the layer.

Returns:

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

getEnableAutoHealing

public Boolean getEnableAutoHealing()

Whether to disable auto healing for the layer.

Returns:

Whether to disable auto healing for the layer.

isAutoAssignElasticIps

public Boolean isAutoAssignElasticIps()

Whether to automatically assign an Elastic IP address to the layer.

Returns:

Whether to automatically assign an Elastic IP address to the layer.

setAutoAssignElasticIps

public void setAutoAssignElasticIps(Boolean autoAssignElasticIps)

Whether to automatically assign an Elastic IP address to the layer.

Parameters:

autoAssignElasticIps - Whether to automatically assign an Elastic IP address to the layer.

withAutoAssignElasticIps

public UpdateLayerRequest withAutoAssignElasticIps(Boolean autoAssignElasticIps)

Whether to automatically assign an Elastic IP address to the layer.

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

Parameters:

autoAssignElasticIps - Whether to automatically assign an Elastic IP address to the layer.

Returns:

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

getAutoAssignElasticIps

public Boolean getAutoAssignElasticIps()

Whether to automatically assign an Elastic IP address to the layer.

Returns:

Whether to automatically assign an Elastic IP address to the layer.

getCustomRecipes

public Recipes getCustomRecipes()

A LayerCustomRecipes object that specifies the layer's custom recipes.

Returns:

A LayerCustomRecipes object that specifies the layer's custom recipes.

setCustomRecipes

public void setCustomRecipes(Recipes customRecipes)

A LayerCustomRecipes object that specifies the layer's custom recipes.

Parameters:

customRecipes - A LayerCustomRecipes object that specifies the layer's custom recipes.

withCustomRecipes

public UpdateLayerRequest withCustomRecipes(Recipes customRecipes)

A LayerCustomRecipes object that specifies the layer's custom recipes.

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

Parameters:

customRecipes - A LayerCustomRecipes object that specifies the layer's custom recipes.

Returns:

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

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

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