Did this page help you?

   Yes   No   Tell us about it...

com.amazonaws.services.opsworks.model
Class Layer

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

public class Layer
extends Object
implements Serializable

Describes a layer.

See Also:
Serialized Form

Constructor Summary
Layer()
           
 
Method Summary
 boolean equals(Object obj)
           
 Map<String,String> getAttributes()
          The layer attributes.
 Boolean getAutoAssignElasticIps()
          Whether the layer has an automatically assigned Elastic IP address.
 String getCreatedAt()
          Date when the layer was created.
 String getCustomInstanceProfileArn()
          The ARN of the default IAM profile to be used for 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.
 Recipes getDefaultRecipes()
          OpsWorks supports five lifecycle events, setup, configuration, deploy, undeploy, and shutdown.
 List<String> getDefaultSecurityGroupNames()
          An array containing the layer's security group names.
 Boolean getEnableAutoHealing()
          Whether auto healing is disabled for the layer.
 String getLayerId()
          The layer ID.
 String getName()
          The layer name.
 List<String> getPackages()
          An array of Package objects that describe the layer's packages.
 String getShortname()
          The layer short name.
 String getStackId()
          The layer stack ID.
 String getType()
          The layer type, which must be one of the following: Custom GangliaMonitoringMaster HaProxy MemcachedServer MySqlMaster NodeJsAppServer PhpAppServer RailsAppServer WebServer
 List<VolumeConfiguration> getVolumeConfigurations()
          A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
 int hashCode()
           
 Boolean isAutoAssignElasticIps()
          Whether the layer has an automatically assigned Elastic IP address.
 Boolean isEnableAutoHealing()
          Whether auto healing is disabled for the layer.
 void setAttributes(Map<String,String> attributes)
          The layer attributes.
 void setAutoAssignElasticIps(Boolean autoAssignElasticIps)
          Whether the layer has an automatically assigned Elastic IP address.
 void setCreatedAt(String createdAt)
          Date when the layer was created.
 void setCustomInstanceProfileArn(String customInstanceProfileArn)
          The ARN of the default IAM profile to be used for 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 setDefaultRecipes(Recipes defaultRecipes)
          OpsWorks supports five lifecycle events, setup, configuration, deploy, undeploy, and shutdown.
 void setDefaultSecurityGroupNames(Collection<String> defaultSecurityGroupNames)
          An array containing the layer's security group names.
 void setEnableAutoHealing(Boolean enableAutoHealing)
          Whether auto healing is disabled for the layer.
 void setLayerId(String layerId)
          The layer ID.
 void setName(String name)
          The layer name.
 void setPackages(Collection<String> packages)
          An array of Package objects that describe the layer's packages.
 void setShortname(String shortname)
          The layer short name.
 void setStackId(String stackId)
          The layer stack ID.
 void setType(LayerType type)
          The layer type, which must be one of the following: Custom GangliaMonitoringMaster HaProxy MemcachedServer MySqlMaster NodeJsAppServer PhpAppServer RailsAppServer WebServer
 void setType(String type)
          The layer type, which must be one of the following: Custom GangliaMonitoringMaster HaProxy MemcachedServer MySqlMaster NodeJsAppServer PhpAppServer RailsAppServer WebServer
 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.
 Layer withAttributes(Map<String,String> attributes)
          The layer attributes.
 Layer withAutoAssignElasticIps(Boolean autoAssignElasticIps)
          Whether the layer has an automatically assigned Elastic IP address.
 Layer withCreatedAt(String createdAt)
          Date when the layer was created.
 Layer withCustomInstanceProfileArn(String customInstanceProfileArn)
          The ARN of the default IAM profile to be used for the layer's EC2 instances.
 Layer withCustomRecipes(Recipes customRecipes)
          A LayerCustomRecipes object that specifies the layer's custom recipes.
 Layer withCustomSecurityGroupIds(Collection<String> customSecurityGroupIds)
          An array containing the layer's custom security group IDs.
 Layer withCustomSecurityGroupIds(String... customSecurityGroupIds)
          An array containing the layer's custom security group IDs.
 Layer withDefaultRecipes(Recipes defaultRecipes)
          OpsWorks supports five lifecycle events, setup, configuration, deploy, undeploy, and shutdown.
 Layer withDefaultSecurityGroupNames(Collection<String> defaultSecurityGroupNames)
          An array containing the layer's security group names.
 Layer withDefaultSecurityGroupNames(String... defaultSecurityGroupNames)
          An array containing the layer's security group names.
 Layer withEnableAutoHealing(Boolean enableAutoHealing)
          Whether auto healing is disabled for the layer.
 Layer withLayerId(String layerId)
          The layer ID.
 Layer withName(String name)
          The layer name.
 Layer withPackages(Collection<String> packages)
          An array of Package objects that describe the layer's packages.
 Layer withPackages(String... packages)
          An array of Package objects that describe the layer's packages.
 Layer withShortname(String shortname)
          The layer short name.
 Layer withStackId(String stackId)
          The layer stack ID.
 Layer withType(LayerType type)
          The layer type, which must be one of the following: Custom GangliaMonitoringMaster HaProxy MemcachedServer MySqlMaster NodeJsAppServer PhpAppServer RailsAppServer WebServer
 Layer withType(String type)
          The layer type, which must be one of the following: Custom GangliaMonitoringMaster HaProxy MemcachedServer MySqlMaster NodeJsAppServer PhpAppServer RailsAppServer WebServer
 Layer withVolumeConfigurations(Collection<VolumeConfiguration> volumeConfigurations)
          A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
 Layer withVolumeConfigurations(VolumeConfiguration... volumeConfigurations)
          A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Layer

public Layer()
Method Detail

getStackId

public String getStackId()
The layer stack ID.

Returns:
The layer stack ID.

setStackId

public void setStackId(String stackId)
The layer stack ID.

Parameters:
stackId - The layer stack ID.

withStackId

public Layer withStackId(String stackId)
The layer stack ID.

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

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

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

getType

public String getType()
The layer type, which must be one of the following:

Constraints:
Allowed Values: lb, web, php-app, rails-app, nodejs-app, memcached, db-master, monitoring-master, custom

Returns:
The layer type, which must be one of the following:
  • Custom
  • GangliaMonitoringMaster
  • HaProxy
  • MemcachedServer
  • MySqlMaster
  • NodeJsAppServer
  • PhpAppServer
  • RailsAppServer
  • WebServer
See Also:
LayerType

setType

public void setType(String type)
The layer type, which must be one of the following:

Constraints:
Allowed Values: lb, web, php-app, rails-app, nodejs-app, memcached, db-master, monitoring-master, custom

Parameters:
type - The layer type, which must be one of the following:
  • Custom
  • GangliaMonitoringMaster
  • HaProxy
  • MemcachedServer
  • MySqlMaster
  • NodeJsAppServer
  • PhpAppServer
  • RailsAppServer
  • WebServer
See Also:
LayerType

withType

public Layer withType(String type)
The layer type, which must be one of the following:

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

Constraints:
Allowed Values: lb, web, php-app, rails-app, nodejs-app, memcached, db-master, monitoring-master, custom

Parameters:
type - The layer type, which must be one of the following:
  • Custom
  • GangliaMonitoringMaster
  • HaProxy
  • MemcachedServer
  • MySqlMaster
  • NodeJsAppServer
  • PhpAppServer
  • RailsAppServer
  • WebServer
Returns:
A reference to this updated object so that method calls can be chained together.
See Also:
LayerType

setType

public void setType(LayerType type)
The layer type, which must be one of the following:

Constraints:
Allowed Values: lb, web, php-app, rails-app, nodejs-app, memcached, db-master, monitoring-master, custom

Parameters:
type - The layer type, which must be one of the following:
  • Custom
  • GangliaMonitoringMaster
  • HaProxy
  • MemcachedServer
  • MySqlMaster
  • NodeJsAppServer
  • PhpAppServer
  • RailsAppServer
  • WebServer
See Also:
LayerType

withType

public Layer withType(LayerType type)
The layer type, which must be one of the following:

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

Constraints:
Allowed Values: lb, web, php-app, rails-app, nodejs-app, memcached, db-master, monitoring-master, custom

Parameters:
type - The layer type, which must be one of the following:
  • Custom
  • GangliaMonitoringMaster
  • HaProxy
  • MemcachedServer
  • MySqlMaster
  • NodeJsAppServer
  • PhpAppServer
  • RailsAppServer
  • WebServer
Returns:
A reference to this updated object so that method calls can be chained together.
See Also:
LayerType

getName

public String getName()
The layer name.

Returns:
The layer name.

setName

public void setName(String name)
The layer name.

Parameters:
name - The layer name.

withName

public Layer withName(String name)
The layer name.

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

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

getShortname

public String getShortname()
The layer short name.

Returns:
The layer short name.

setShortname

public void setShortname(String shortname)
The layer short name.

Parameters:
shortname - The layer short name.

withShortname

public Layer withShortname(String shortname)
The layer short name.

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

Parameters:
shortname - The layer short name.
Returns:
A reference to this updated object so that method calls can be chained together.

getAttributes

public Map<String,String> getAttributes()
The layer attributes.

Returns:
The layer attributes.

setAttributes

public void setAttributes(Map<String,String> attributes)
The layer attributes.

Parameters:
attributes - The layer attributes.

withAttributes

public Layer withAttributes(Map<String,String> attributes)
The layer attributes.

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

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

getCustomInstanceProfileArn

public String getCustomInstanceProfileArn()
The ARN of the default IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

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

setCustomInstanceProfileArn

public void setCustomInstanceProfileArn(String customInstanceProfileArn)
The ARN of the default IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

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

withCustomInstanceProfileArn

public Layer withCustomInstanceProfileArn(String customInstanceProfileArn)
The ARN of the default IAM profile to be used for 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 the default IAM profile to be used for 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 Layer 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 Layer 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.

getDefaultSecurityGroupNames

public List<String> getDefaultSecurityGroupNames()
An array containing the layer's security group names.

Returns:
An array containing the layer's security group names.

setDefaultSecurityGroupNames

public void setDefaultSecurityGroupNames(Collection<String> defaultSecurityGroupNames)
An array containing the layer's security group names.

Parameters:
defaultSecurityGroupNames - An array containing the layer's security group names.

withDefaultSecurityGroupNames

public Layer withDefaultSecurityGroupNames(String... defaultSecurityGroupNames)
An array containing the layer's security group names.

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

Parameters:
defaultSecurityGroupNames - An array containing the layer's security group names.
Returns:
A reference to this updated object so that method calls can be chained together.

withDefaultSecurityGroupNames

public Layer withDefaultSecurityGroupNames(Collection<String> defaultSecurityGroupNames)
An array containing the layer's security group names.

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

Parameters:
defaultSecurityGroupNames - An array containing the layer's security group names.
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 Layer 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 Layer 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 Layer 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 Layer 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 auto healing is disabled for the layer.

Returns:
Whether auto healing is disabled for the layer.

setEnableAutoHealing

public void setEnableAutoHealing(Boolean enableAutoHealing)
Whether auto healing is disabled for the layer.

Parameters:
enableAutoHealing - Whether auto healing is disabled for the layer.

withEnableAutoHealing

public Layer withEnableAutoHealing(Boolean enableAutoHealing)
Whether auto healing is disabled for the layer.

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

Parameters:
enableAutoHealing - Whether auto healing is disabled for the layer.
Returns:
A reference to this updated object so that method calls can be chained together.

getEnableAutoHealing

public Boolean getEnableAutoHealing()
Whether auto healing is disabled for the layer.

Returns:
Whether auto healing is disabled for the layer.

isAutoAssignElasticIps

public Boolean isAutoAssignElasticIps()
Whether the layer has an automatically assigned Elastic IP address.

Returns:
Whether the layer has an automatically assigned Elastic IP address.

setAutoAssignElasticIps

public void setAutoAssignElasticIps(Boolean autoAssignElasticIps)
Whether the layer has an automatically assigned Elastic IP address.

Parameters:
autoAssignElasticIps - Whether the layer has an automatically assigned Elastic IP address.

withAutoAssignElasticIps

public Layer withAutoAssignElasticIps(Boolean autoAssignElasticIps)
Whether the layer has an automatically assigned Elastic IP address.

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

Parameters:
autoAssignElasticIps - Whether the layer has an automatically assigned Elastic IP address.
Returns:
A reference to this updated object so that method calls can be chained together.

getAutoAssignElasticIps

public Boolean getAutoAssignElasticIps()
Whether the layer has an automatically assigned Elastic IP address.

Returns:
Whether the layer has an automatically assigned Elastic IP address.

getDefaultRecipes

public Recipes getDefaultRecipes()
OpsWorks supports five lifecycle events, setup, configuration, deploy, undeploy, and shutdown. For each layer, OpsWorks runs a set of standard recipes for each event. In addition, you can provide custom recipes for any or all layers and events. OpsWorks runs custom event recipes after the standard recipes. LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of the five events.

To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in the repository's phpapp2 folder.

Returns:
OpsWorks supports five lifecycle events, setup, configuration, deploy, undeploy, and shutdown. For each layer, OpsWorks runs a set of standard recipes for each event. In addition, you can provide custom recipes for any or all layers and events. OpsWorks runs custom event recipes after the standard recipes. LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of the five events.

To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in the repository's phpapp2 folder.


setDefaultRecipes

public void setDefaultRecipes(Recipes defaultRecipes)
OpsWorks supports five lifecycle events, setup, configuration, deploy, undeploy, and shutdown. For each layer, OpsWorks runs a set of standard recipes for each event. In addition, you can provide custom recipes for any or all layers and events. OpsWorks runs custom event recipes after the standard recipes. LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of the five events.

To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in the repository's phpapp2 folder.

Parameters:
defaultRecipes - OpsWorks supports five lifecycle events, setup, configuration, deploy, undeploy, and shutdown. For each layer, OpsWorks runs a set of standard recipes for each event. In addition, you can provide custom recipes for any or all layers and events. OpsWorks runs custom event recipes after the standard recipes. LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of the five events.

To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in the repository's phpapp2 folder.


withDefaultRecipes

public Layer withDefaultRecipes(Recipes defaultRecipes)
OpsWorks supports five lifecycle events, setup, configuration, deploy, undeploy, and shutdown. For each layer, OpsWorks runs a set of standard recipes for each event. In addition, you can provide custom recipes for any or all layers and events. OpsWorks runs custom event recipes after the standard recipes. LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of the five events.

To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in the repository's phpapp2 folder.

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

Parameters:
defaultRecipes - OpsWorks supports five lifecycle events, setup, configuration, deploy, undeploy, and shutdown. For each layer, OpsWorks runs a set of standard recipes for each event. In addition, you can provide custom recipes for any or all layers and events. OpsWorks runs custom event recipes after the standard recipes. LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of the five events.

To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in the repository's phpapp2 folder.

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

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

getCreatedAt

public String getCreatedAt()
Date when the layer was created.

Returns:
Date when the layer was created.

setCreatedAt

public void setCreatedAt(String createdAt)
Date when the layer was created.

Parameters:
createdAt - Date when the layer was created.

withCreatedAt

public Layer withCreatedAt(String createdAt)
Date when the layer was created.

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

Parameters:
createdAt - Date when the layer was created.
Returns:
A reference to this updated object so that method calls can be chained together.

toString

public String toString()
Returns a string representation of this object; useful for testing and debugging.

Overrides:
toString in class Object
Returns:
A string representation of this object.
See Also:
Object.toString()

hashCode

public int hashCode()
Overrides:
hashCode in class Object

equals

public boolean equals(Object obj)
Overrides:
equals in class Object


Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.