public class UpdateLayerRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
UpdateLayer operation
.
Updates a specified layer.
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 .
NOOP
Constructor and Description |
---|
UpdateLayerRequest() |
Modifier and Type | Method and Description |
---|---|
UpdateLayerRequest |
addAttributesEntry(String key,
String value)
One or more user-defined key/value pairs to be added to the stack
attributes.
|
UpdateLayerRequest |
clearAttributesEntries()
Removes all the entries added into Attributes.
|
UpdateLayerRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(Object obj) |
Map<String,String> |
getAttributes()
One or more user-defined key/value pairs to be added to the stack
attributes.
|
Boolean |
getAutoAssignElasticIps()
Whether to automatically assign an Elastic
IP address to the layer's instances.
|
Boolean |
getAutoAssignPublicIps()
For stacks that are running in a VPC, whether to automatically assign
a public IP address to the layer's instances.
|
String |
getCustomInstanceProfileArn()
The ARN of an IAM profile to be used for all of the layer's EC2
instances.
|
String |
getCustomJson()
A JSON-formatted string containing custom stack configuration and
deployment attributes to be installed on the layer's 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.
|
LifecycleEventConfiguration |
getLifecycleEventConfiguration()
|
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()
For custom layers only, use this parameter to specify the layer's
short name, which is used internally by AWS OpsWorksand by Chef.
|
Boolean |
getUseEbsOptimizedInstances()
Whether to use Amazon EBS-optimized instances.
|
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's instances.
|
Boolean |
isAutoAssignPublicIps()
For stacks that are running in a VPC, whether to automatically assign
a public IP address to the layer's instances.
|
Boolean |
isEnableAutoHealing()
Whether to disable auto healing for the layer.
|
Boolean |
isInstallUpdatesOnBoot()
Whether to install operating system and package updates when the
instance boots.
|
Boolean |
isUseEbsOptimizedInstances()
Whether to use Amazon EBS-optimized instances.
|
void |
setAttributes(Map<String,String> attributes)
One or more user-defined key/value pairs to be added to the stack
attributes.
|
void |
setAutoAssignElasticIps(Boolean autoAssignElasticIps)
Whether to automatically assign an Elastic
IP address to the layer's instances.
|
void |
setAutoAssignPublicIps(Boolean autoAssignPublicIps)
For stacks that are running in a VPC, whether to automatically assign
a public IP address to the layer's instances.
|
void |
setCustomInstanceProfileArn(String customInstanceProfileArn)
The ARN of an IAM profile to be used for all of the layer's EC2
instances.
|
void |
setCustomJson(String customJson)
A JSON-formatted string containing custom stack configuration and
deployment attributes to be installed on the layer's 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 |
setLifecycleEventConfiguration(LifecycleEventConfiguration lifecycleEventConfiguration)
|
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)
For custom layers only, use this parameter to specify the layer's
short name, which is used internally by AWS OpsWorksand by Chef.
|
void |
setUseEbsOptimizedInstances(Boolean useEbsOptimizedInstances)
Whether to use Amazon EBS-optimized instances.
|
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.
|
UpdateLayerRequest |
withAutoAssignElasticIps(Boolean autoAssignElasticIps)
Whether to automatically assign an Elastic
IP address to the layer's instances.
|
UpdateLayerRequest |
withAutoAssignPublicIps(Boolean autoAssignPublicIps)
For stacks that are running in a VPC, whether to automatically assign
a public IP address to the layer's instances.
|
UpdateLayerRequest |
withCustomInstanceProfileArn(String customInstanceProfileArn)
The ARN of an IAM profile to be used for all of the layer's EC2
instances.
|
UpdateLayerRequest |
withCustomJson(String customJson)
A JSON-formatted string containing custom stack configuration and
deployment attributes to be installed on the layer's 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 |
withLifecycleEventConfiguration(LifecycleEventConfiguration lifecycleEventConfiguration)
|
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)
For custom layers only, use this parameter to specify the layer's
short name, which is used internally by AWS OpsWorksand by Chef.
|
UpdateLayerRequest |
withUseEbsOptimizedInstances(Boolean useEbsOptimizedInstances)
Whether to use Amazon EBS-optimized instances.
|
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. |
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public String getLayerId()
public void setLayerId(String layerId)
layerId
- The layer ID.public UpdateLayerRequest withLayerId(String layerId)
Returns a reference to this object so that method calls can be chained together.
layerId
- The layer ID.public String getName()
public void setName(String name)
name
- The layer name, which is used by the console.public UpdateLayerRequest withName(String name)
Returns a reference to this object so that method calls can be chained together.
name
- The layer name, which is used by the console.public String getShortname()
The built-in layers' short names are defined by AWS OpsWorks. For more information, see the Layer Reference
The built-in layers' short names are defined by AWS OpsWorks. For more information, see the Layer Reference
public void setShortname(String shortname)
The built-in layers' short names are defined by AWS OpsWorks. For more information, see the Layer Reference
shortname
- For custom layers only, use this parameter to specify the layer's
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/. The built-in layers' short names are defined by AWS OpsWorks. For more information, see the Layer Reference
public UpdateLayerRequest withShortname(String shortname)
The built-in layers' short names are defined by AWS OpsWorks. For more information, see the Layer Reference
Returns a reference to this object so that method calls can be chained together.
shortname
- For custom layers only, use this parameter to specify the layer's
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/. The built-in layers' short names are defined by AWS OpsWorks. For more information, see the Layer Reference
public Map<String,String> getAttributes()
public void setAttributes(Map<String,String> attributes)
attributes
- One or more user-defined key/value pairs to be added to the stack
attributes.public UpdateLayerRequest withAttributes(Map<String,String> attributes)
Returns a reference to this object so that method calls can be chained together.
attributes
- One or more user-defined key/value pairs to be added to the stack
attributes.public UpdateLayerRequest addAttributesEntry(String key, String value)
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.
key
- The key of the entry to be added into Attributes.value
- The corresponding value of the entry to be added into Attributes.public UpdateLayerRequest clearAttributesEntries()
Returns a reference to this object so that method calls can be chained together.
public String getCustomInstanceProfileArn()
public void setCustomInstanceProfileArn(String customInstanceProfileArn)
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.public UpdateLayerRequest withCustomInstanceProfileArn(String customInstanceProfileArn)
Returns a reference to this object so that method calls can be chained together.
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.public String getCustomJson()
public void setCustomJson(String customJson)
customJson
- A JSON-formatted string containing custom stack configuration and
deployment attributes to be installed on the layer's instances. For
more information, see
Using Custom JSON.public UpdateLayerRequest withCustomJson(String customJson)
Returns a reference to this object so that method calls can be chained together.
customJson
- A JSON-formatted string containing custom stack configuration and
deployment attributes to be installed on the layer's instances. For
more information, see
Using Custom JSON.public List<String> getCustomSecurityGroupIds()
public void setCustomSecurityGroupIds(Collection<String> customSecurityGroupIds)
customSecurityGroupIds
- An array containing the layer's custom security group IDs.public UpdateLayerRequest withCustomSecurityGroupIds(String... customSecurityGroupIds)
NOTE: This method appends the values to the existing list (if
any). Use setCustomSecurityGroupIds(java.util.Collection)
or
withCustomSecurityGroupIds(java.util.Collection)
if you want
to override the existing values.
Returns a reference to this object so that method calls can be chained together.
customSecurityGroupIds
- An array containing the layer's custom security group IDs.public UpdateLayerRequest withCustomSecurityGroupIds(Collection<String> customSecurityGroupIds)
Returns a reference to this object so that method calls can be chained together.
customSecurityGroupIds
- An array containing the layer's custom security group IDs.public List<String> getPackages()
Package
objects that describe the layer's
packages.Package
objects that describe the layer's
packages.public void setPackages(Collection<String> packages)
Package
objects that describe the layer's
packages.packages
- An array of Package
objects that describe the layer's
packages.public UpdateLayerRequest withPackages(String... packages)
Package
objects that describe the layer's
packages.
NOTE: This method appends the values to the existing list (if
any). Use setPackages(java.util.Collection)
or withPackages(java.util.Collection)
if you want to override the
existing values.
Returns a reference to this object so that method calls can be chained together.
packages
- An array of Package
objects that describe the layer's
packages.public UpdateLayerRequest withPackages(Collection<String> packages)
Package
objects that describe the layer's
packages.
Returns a reference to this object so that method calls can be chained together.
packages
- An array of Package
objects that describe the layer's
packages.public List<VolumeConfiguration> getVolumeConfigurations()
VolumeConfigurations
object that describes the layer's
Amazon EBS volumes.VolumeConfigurations
object that describes the layer's
Amazon EBS volumes.public void setVolumeConfigurations(Collection<VolumeConfiguration> volumeConfigurations)
VolumeConfigurations
object that describes the layer's
Amazon EBS volumes.volumeConfigurations
- A VolumeConfigurations
object that describes the layer's
Amazon EBS volumes.public UpdateLayerRequest withVolumeConfigurations(VolumeConfiguration... volumeConfigurations)
VolumeConfigurations
object that describes the layer's
Amazon EBS volumes.
NOTE: This method appends the values to the existing list (if
any). Use setVolumeConfigurations(java.util.Collection)
or
withVolumeConfigurations(java.util.Collection)
if you want to
override the existing values.
Returns a reference to this object so that method calls can be chained together.
volumeConfigurations
- A VolumeConfigurations
object that describes the layer's
Amazon EBS volumes.public UpdateLayerRequest withVolumeConfigurations(Collection<VolumeConfiguration> volumeConfigurations)
VolumeConfigurations
object that describes the layer's
Amazon EBS volumes.
Returns a reference to this object so that method calls can be chained together.
volumeConfigurations
- A VolumeConfigurations
object that describes the layer's
Amazon EBS volumes.public Boolean isEnableAutoHealing()
public void setEnableAutoHealing(Boolean enableAutoHealing)
enableAutoHealing
- Whether to disable auto healing for the layer.public UpdateLayerRequest withEnableAutoHealing(Boolean enableAutoHealing)
Returns a reference to this object so that method calls can be chained together.
enableAutoHealing
- Whether to disable auto healing for the layer.public Boolean getEnableAutoHealing()
public Boolean isAutoAssignElasticIps()
public void setAutoAssignElasticIps(Boolean autoAssignElasticIps)
autoAssignElasticIps
- Whether to automatically assign an Elastic
IP address to the layer's instances. For more information, see How
to Edit a Layer.public UpdateLayerRequest withAutoAssignElasticIps(Boolean autoAssignElasticIps)
Returns a reference to this object so that method calls can be chained together.
autoAssignElasticIps
- Whether to automatically assign an Elastic
IP address to the layer's instances. For more information, see How
to Edit a Layer.public Boolean getAutoAssignElasticIps()
public Boolean isAutoAssignPublicIps()
public void setAutoAssignPublicIps(Boolean autoAssignPublicIps)
autoAssignPublicIps
- For stacks that are running in a VPC, whether to automatically assign
a public IP address to the layer's instances. For more information,
see How
to Edit a Layer.public UpdateLayerRequest withAutoAssignPublicIps(Boolean autoAssignPublicIps)
Returns a reference to this object so that method calls can be chained together.
autoAssignPublicIps
- For stacks that are running in a VPC, whether to automatically assign
a public IP address to the layer's instances. For more information,
see How
to Edit a Layer.public Boolean getAutoAssignPublicIps()
public Recipes getCustomRecipes()
LayerCustomRecipes
object that specifies the layer's
custom recipes.LayerCustomRecipes
object that specifies the layer's
custom recipes.public void setCustomRecipes(Recipes customRecipes)
LayerCustomRecipes
object that specifies the layer's
custom recipes.customRecipes
- A LayerCustomRecipes
object that specifies the layer's
custom recipes.public UpdateLayerRequest withCustomRecipes(Recipes customRecipes)
LayerCustomRecipes
object that specifies the layer's
custom recipes.
Returns a reference to this object so that method calls can be chained together.
customRecipes
- A LayerCustomRecipes
object that specifies the layer's
custom recipes.public Boolean isInstallUpdatesOnBoot()
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.
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.
public void setInstallUpdatesOnBoot(Boolean installUpdatesOnBoot)
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.
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.
public UpdateLayerRequest withInstallUpdatesOnBoot(Boolean installUpdatesOnBoot)
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.
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.
public Boolean getInstallUpdatesOnBoot()
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.
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.
public Boolean isUseEbsOptimizedInstances()
public void setUseEbsOptimizedInstances(Boolean useEbsOptimizedInstances)
useEbsOptimizedInstances
- Whether to use Amazon EBS-optimized instances.public UpdateLayerRequest withUseEbsOptimizedInstances(Boolean useEbsOptimizedInstances)
Returns a reference to this object so that method calls can be chained together.
useEbsOptimizedInstances
- Whether to use Amazon EBS-optimized instances.public Boolean getUseEbsOptimizedInstances()
public LifecycleEventConfiguration getLifecycleEventConfiguration()
public void setLifecycleEventConfiguration(LifecycleEventConfiguration lifecycleEventConfiguration)
lifecycleEventConfiguration
- public UpdateLayerRequest withLifecycleEventConfiguration(LifecycleEventConfiguration lifecycleEventConfiguration)
Returns a reference to this object so that method calls can be chained together.
lifecycleEventConfiguration
- public String toString()
toString
in class Object
Object.toString()
public UpdateLayerRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2015. All rights reserved.