Overview  Package   Class  Index  Help 

Did this page help you?

   Yes   No   Tell us about it...
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.amazonaws.services.opsworks.model
Class CreateLayerRequest

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceRequest
      extended by com.amazonaws.services.opsworks.model.CreateLayerRequest
All Implemented Interfaces:
Serializable
public class CreateLayerRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the CreateLayer operation.

Creates a layer. For more information, see How to Create a Layer .

NOTE:You should use CreateLayer for non-custom layer types such as PHP App Server only if the stack does not have an existing layer of that type. A stack can have at most one instance of each non-custom layer; if you attempt to create a second instance, CreateLayer fails. A stack can have an arbitrary number of custom layers, so you can call CreateLayer as many times as you like for that layer type.

See Also:
AWSOpsWorks.createLayer(CreateLayerRequest), Serialized Form

Constructor Summary
CreateLayerRequest()
           
 
Method Summary
 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 that to be used for the layer's EC2 instances.
 Recipes getCustomRecipes()
          A LayerCustomRecipes object that specifies the layer custom recipes.
 List<String> getCustomSecurityGroupIds()
          An array containing the layer custom security group IDs.
 Boolean getEnableAutoHealing()
          Whether to disable auto healing for the layer.
 String getName()
          The layer name, which is used by the console.
 List<String> getPackages()
          An array of Package objects that describe the layer packages.
 String getShortname()
          The layer short name, which is used internally by OpsWorks and by Chef recipes.
 String getStackId()
          The layer stack ID.
 String getType()
          The layer type.
 List<VolumeConfiguration> getVolumeConfigurations()
          A VolumeConfigurations object that describes the layer 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.
 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 that to be used for the layer's EC2 instances.
 void setCustomRecipes(Recipes customRecipes)
          A LayerCustomRecipes object that specifies the layer custom recipes.
 void setCustomSecurityGroupIds(Collection<String> customSecurityGroupIds)
          An array containing the layer custom security group IDs.
 void setEnableAutoHealing(Boolean enableAutoHealing)
          Whether to disable auto healing for the layer.
 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 packages.
 void setShortname(String shortname)
          The layer short name, which is used internally by OpsWorks and by Chef recipes.
 void setStackId(String stackId)
          The layer stack ID.
 void setType(LayerType type)
          The layer type.
 void setType(String type)
          The layer type.
 void setVolumeConfigurations(Collection<VolumeConfiguration> volumeConfigurations)
          A VolumeConfigurations object that describes the layer Amazon EBS volumes.
 String toString()
          Returns a string representation of this object; useful for testing and debugging.
 CreateLayerRequest withAttributes(Map<String,String> attributes)
          One or more user-defined key/value pairs to be added to the stack attributes bag.
 CreateLayerRequest withAutoAssignElasticIps(Boolean autoAssignElasticIps)
          Whether to automatically assign an Elastic IP address to the layer.
 CreateLayerRequest withCustomInstanceProfileArn(String customInstanceProfileArn)
          The ARN of an IAM profile that to be used for the layer's EC2 instances.
 CreateLayerRequest withCustomRecipes(Recipes customRecipes)
          A LayerCustomRecipes object that specifies the layer custom recipes.
 CreateLayerRequest withCustomSecurityGroupIds(Collection<String> customSecurityGroupIds)
          An array containing the layer custom security group IDs.
 CreateLayerRequest withCustomSecurityGroupIds(String... customSecurityGroupIds)
          An array containing the layer custom security group IDs.
 CreateLayerRequest withEnableAutoHealing(Boolean enableAutoHealing)
          Whether to disable auto healing for the layer.
 CreateLayerRequest withName(String name)
          The layer name, which is used by the console.
 CreateLayerRequest withPackages(Collection<String> packages)
          An array of Package objects that describe the layer packages.
 CreateLayerRequest withPackages(String... packages)
          An array of Package objects that describe the layer packages.
 CreateLayerRequest withShortname(String shortname)
          The layer short name, which is used internally by OpsWorks and by Chef recipes.
 CreateLayerRequest withStackId(String stackId)
          The layer stack ID.
 CreateLayerRequest withType(LayerType type)
          The layer type.
 CreateLayerRequest withType(String type)
          The layer type.
 CreateLayerRequest withVolumeConfigurations(Collection<VolumeConfiguration> volumeConfigurations)
          A VolumeConfigurations object that describes the layer Amazon EBS volumes.
 CreateLayerRequest withVolumeConfigurations(VolumeConfiguration... volumeConfigurations)
          A VolumeConfigurations object that describes the layer 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

CreateLayerRequest

public CreateLayerRequest()
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 CreateLayerRequest 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.

getType

public String getType()
The layer type. A stack cannot have more than one layer of the same type. This parameter must be set to 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. A stack cannot have more than one layer of the same type. This parameter must be set to one of the following:
  • lb: An HAProxy layer
  • web: A Static Web Server layer
  • rails-app: A Rails App Server layer
  • php-app: A PHP App Server layer
  • nodejs-app: A Node.js App Server layer
  • memcached: A Memcached layer
  • db-master: A MySQL layer
  • monitoring-master: A Ganglia layer
  • custom: A custom layer
See Also:
LayerType

setType

public void setType(String type)
The layer type. A stack cannot have more than one layer of the same type. This parameter must be set to 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. A stack cannot have more than one layer of the same type. This parameter must be set to one of the following:
  • lb: An HAProxy layer
  • web: A Static Web Server layer
  • rails-app: A Rails App Server layer
  • php-app: A PHP App Server layer
  • nodejs-app: A Node.js App Server layer
  • memcached: A Memcached layer
  • db-master: A MySQL layer
  • monitoring-master: A Ganglia layer
  • custom: A custom layer
See Also:
LayerType

withType

public CreateLayerRequest withType(String type)
The layer type. A stack cannot have more than one layer of the same type. This parameter must be set to 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. A stack cannot have more than one layer of the same type. This parameter must be set to one of the following:
  • lb: An HAProxy layer
  • web: A Static Web Server layer
  • rails-app: A Rails App Server layer
  • php-app: A PHP App Server layer
  • nodejs-app: A Node.js App Server layer
  • memcached: A Memcached layer
  • db-master: A MySQL layer
  • monitoring-master: A Ganglia layer
  • custom: A custom layer
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. A stack cannot have more than one layer of the same type. This parameter must be set to 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. A stack cannot have more than one layer of the same type. This parameter must be set to one of the following:
  • lb: An HAProxy layer
  • web: A Static Web Server layer
  • rails-app: A Rails App Server layer
  • php-app: A PHP App Server layer
  • nodejs-app: A Node.js App Server layer
  • memcached: A Memcached layer
  • db-master: A MySQL layer
  • monitoring-master: A Ganglia layer
  • custom: A custom layer
See Also:
LayerType

withType

public CreateLayerRequest withType(LayerType type)
The layer type. A stack cannot have more than one layer of the same type. This parameter must be set to 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. A stack cannot have more than one layer of the same type. This parameter must be set to one of the following:
  • lb: An HAProxy layer
  • web: A Static Web Server layer
  • rails-app: A Rails App Server layer
  • php-app: A PHP App Server layer
  • nodejs-app: A Node.js App Server layer
  • memcached: A Memcached layer
  • db-master: A MySQL layer
  • monitoring-master: A Ganglia layer
  • custom: A custom layer
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, 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 CreateLayerRequest 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 OpsWorks and by Chef recipes. The shortname is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric characters, '-', '_', and '.'.

Returns:
The layer short name, which is used internally by OpsWorks and by Chef recipes. The shortname is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric characters, '-', '_', and '.'.

setShortname

public void setShortname(String shortname)
The layer short name, which is used internally by OpsWorks and by Chef recipes. The shortname is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric characters, '-', '_', and '.'.

Parameters:
shortname - The layer short name, which is used internally by OpsWorks and by Chef recipes. The shortname is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric characters, '-', '_', and '.'.

withShortname

public CreateLayerRequest withShortname(String shortname)
The layer short name, which is used internally by OpsWorks and by Chef recipes. The shortname is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric characters, '-', '_', and '.'.

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 OpsWorks and by Chef recipes. The shortname is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric characters, '-', '_', and '.'.
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 CreateLayerRequest 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.

getCustomInstanceProfileArn

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

Returns:
The ARN of an IAM profile that 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 an IAM profile that to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

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

withCustomInstanceProfileArn

public CreateLayerRequest withCustomInstanceProfileArn(String customInstanceProfileArn)
The ARN of an IAM profile that 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 an IAM profile that 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 custom security group IDs.

Returns:
An array containing the layer custom security group IDs.

setCustomSecurityGroupIds

public void setCustomSecurityGroupIds(Collection<String> customSecurityGroupIds)
An array containing the layer custom security group IDs.

Parameters:
customSecurityGroupIds - An array containing the layer custom security group IDs.

withCustomSecurityGroupIds

public CreateLayerRequest withCustomSecurityGroupIds(String... customSecurityGroupIds)
An array containing the layer 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 custom security group IDs.
Returns:
A reference to this updated object so that method calls can be chained together.

withCustomSecurityGroupIds

public CreateLayerRequest withCustomSecurityGroupIds(Collection<String> customSecurityGroupIds)
An array containing the layer 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 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 packages.

Returns:
An array of Package objects that describe the layer packages.

setPackages

public void setPackages(Collection<String> packages)
An array of Package objects that describe the layer packages.

Parameters:
packages - An array of Package objects that describe the layer packages.

withPackages

public CreateLayerRequest withPackages(String... packages)
An array of Package objects that describe the layer 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 packages.
Returns:
A reference to this updated object so that method calls can be chained together.

withPackages

public CreateLayerRequest withPackages(Collection<String> packages)
An array of Package objects that describe the layer 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 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 Amazon EBS volumes.

Returns:
A VolumeConfigurations object that describes the layer Amazon EBS volumes.

setVolumeConfigurations

public void setVolumeConfigurations(Collection<VolumeConfiguration> volumeConfigurations)
A VolumeConfigurations object that describes the layer Amazon EBS volumes.

Parameters:
volumeConfigurations - A VolumeConfigurations object that describes the layer Amazon EBS volumes.

withVolumeConfigurations

public CreateLayerRequest withVolumeConfigurations(VolumeConfiguration... volumeConfigurations)
A VolumeConfigurations object that describes the layer 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 Amazon EBS volumes.
Returns:
A reference to this updated object so that method calls can be chained together.

withVolumeConfigurations

public CreateLayerRequest withVolumeConfigurations(Collection<VolumeConfiguration> volumeConfigurations)
A VolumeConfigurations object that describes the layer 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 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 CreateLayerRequest 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 CreateLayerRequest 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 custom recipes.

Returns:
A LayerCustomRecipes object that specifies the layer custom recipes.

setCustomRecipes

public void setCustomRecipes(Recipes customRecipes)
A LayerCustomRecipes object that specifies the layer custom recipes.

Parameters:
customRecipes - A LayerCustomRecipes object that specifies the layer custom recipes.

withCustomRecipes

public CreateLayerRequest withCustomRecipes(Recipes customRecipes)
A LayerCustomRecipes object that specifies the layer 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 custom recipes.
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
Overview  Package   Class  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.