Class Layer
- All Implemented Interfaces:
Serializable
,Cloneable
Describes a layer.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAttributesEntry
(String key, String value) Removes all the entries added into Attributes.clone()
boolean
The layer attributes.Whether to automatically assign an Elastic IP address to the layer's instances.For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances.Date when the layer was created.The ARN of the default IAM profile to be used for the layer's EC2 instances.A JSON formatted string containing the layer's custom stack configuration and deployment attributes.ALayerCustomRecipes
object that specifies the layer's custom recipes.An array containing the layer's custom security group IDs.An array containing the layer's security group names.Whether auto healing is disabled for the layer.Whether to install operating system and package updates when the instance boots.The layer ID.ALifeCycleEventConfiguration
object that specifies the Shutdown event configuration.getName()
The layer name.An array ofPackage
objects that describe the layer's packages.The layer short name.The layer stack ID.getType()
The layer type.Whether the layer uses Amazon EBS-optimized instances.AVolumeConfigurations
object that describes the layer's Amazon EBS volumes.int
hashCode()
Whether to automatically assign an Elastic IP address to the layer's instances.For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances.Whether auto healing is disabled for the layer.Whether to install operating system and package updates when the instance boots.Whether the layer uses Amazon EBS-optimized instances.void
setAttributes
(Map<String, String> attributes) The layer 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
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
setCustomJson
(String customJson) A JSON formatted string containing the layer's custom stack configuration and deployment attributes.void
setCustomRecipes
(Recipes customRecipes) ALayerCustomRecipes
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) 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
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) ALifeCycleEventConfiguration
object that specifies the Shutdown event configuration.void
The layer name.void
setPackages
(Collection<String> packages) An array ofPackage
objects that describe the layer's packages.void
setShortname
(String shortname) The layer short name.void
setStackId
(String stackId) The layer stack ID.void
The layer type.void
The layer type.void
setUseEbsOptimizedInstances
(Boolean useEbsOptimizedInstances) Whether the layer uses Amazon EBS-optimized instances.void
setVolumeConfigurations
(Collection<VolumeConfiguration> volumeConfigurations) AVolumeConfigurations
object that describes the layer's Amazon EBS volumes.toString()
Returns a string representation of this object; useful for testing and debugging.withAttributes
(Map<String, String> attributes) The layer attributes.withAutoAssignElasticIps
(Boolean autoAssignElasticIps) Whether to automatically assign an Elastic IP address to the layer's instances.withAutoAssignPublicIps
(Boolean autoAssignPublicIps) For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances.withCreatedAt
(String createdAt) Date when the layer was created.withCustomInstanceProfileArn
(String customInstanceProfileArn) The ARN of the default IAM profile to be used for the layer's EC2 instances.withCustomJson
(String customJson) A JSON formatted string containing the layer's custom stack configuration and deployment attributes.withCustomRecipes
(Recipes customRecipes) ALayerCustomRecipes
object that specifies the layer's custom recipes.withCustomSecurityGroupIds
(String... customSecurityGroupIds) An array containing the layer's custom security group IDs.withCustomSecurityGroupIds
(Collection<String> customSecurityGroupIds) An array containing the layer's custom security group IDs.withDefaultRecipes
(Recipes defaultRecipes) withDefaultSecurityGroupNames
(String... defaultSecurityGroupNames) An array containing the layer's security group names.withDefaultSecurityGroupNames
(Collection<String> defaultSecurityGroupNames) An array containing the layer's security group names.withEnableAutoHealing
(Boolean enableAutoHealing) Whether auto healing is disabled for the layer.withInstallUpdatesOnBoot
(Boolean installUpdatesOnBoot) Whether to install operating system and package updates when the instance boots.withLayerId
(String layerId) The layer ID.withLifecycleEventConfiguration
(LifecycleEventConfiguration lifecycleEventConfiguration) ALifeCycleEventConfiguration
object that specifies the Shutdown event configuration.The layer name.withPackages
(String... packages) An array ofPackage
objects that describe the layer's packages.withPackages
(Collection<String> packages) An array ofPackage
objects that describe the layer's packages.withShortname
(String shortname) The layer short name.withStackId
(String stackId) The layer stack ID.The layer type.The layer type.withUseEbsOptimizedInstances
(Boolean useEbsOptimizedInstances) Whether the layer uses Amazon EBS-optimized instances.withVolumeConfigurations
(VolumeConfiguration... volumeConfigurations) AVolumeConfigurations
object that describes the layer's Amazon EBS volumes.withVolumeConfigurations
(Collection<VolumeConfiguration> volumeConfigurations) AVolumeConfigurations
object that describes the layer's Amazon EBS volumes.
-
Constructor Details
-
Layer
public Layer()
-
-
Method Details
-
setStackId
The layer stack ID.
- Parameters:
stackId
- The layer stack ID.
-
getStackId
The layer stack ID.
- Returns:
- The layer stack ID.
-
withStackId
The layer stack ID.
- Parameters:
stackId
- The layer stack ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLayerId
The layer ID.
- Parameters:
layerId
- The layer ID.
-
getLayerId
The layer ID.
- Returns:
- The layer ID.
-
withLayerId
The layer ID.
- Parameters:
layerId
- The layer ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setType
The layer type.
- Parameters:
type
- The layer type.- See Also:
-
getType
The layer type.
- Returns:
- The layer type.
- See Also:
-
withType
The layer type.
- Parameters:
type
- The layer type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setType
The layer type.
- Parameters:
type
- The layer type.- See Also:
-
withType
The layer type.
- Parameters:
type
- The layer type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setName
The layer name.
- Parameters:
name
- The layer name.
-
getName
The layer name.
- Returns:
- The layer name.
-
withName
The layer name.
- Parameters:
name
- The layer name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setShortname
The layer short name.
- Parameters:
shortname
- The layer short name.
-
getShortname
The layer short name.
- Returns:
- The layer short name.
-
withShortname
The layer short name.
- Parameters:
shortname
- The layer short name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getAttributes
The layer attributes.
For the
HaproxyStatsPassword
,MysqlRootPassword
, andGangliaPassword
attributes, AWS OpsWorks returns*****FILTERED*****
instead of the actual valueFor an ECS Cluster layer, AWS OpsWorks the
EcsClusterArn
attribute is set to the cluster's ARN.- Returns:
- The layer attributes.
For the
HaproxyStatsPassword
,MysqlRootPassword
, andGangliaPassword
attributes, AWS OpsWorks returns*****FILTERED*****
instead of the actual valueFor an ECS Cluster layer, AWS OpsWorks the
EcsClusterArn
attribute is set to the cluster's ARN.
-
setAttributes
The layer attributes.
For the
HaproxyStatsPassword
,MysqlRootPassword
, andGangliaPassword
attributes, AWS OpsWorks returns*****FILTERED*****
instead of the actual valueFor an ECS Cluster layer, AWS OpsWorks the
EcsClusterArn
attribute is set to the cluster's ARN.- Parameters:
attributes
- The layer attributes.For the
HaproxyStatsPassword
,MysqlRootPassword
, andGangliaPassword
attributes, AWS OpsWorks returns*****FILTERED*****
instead of the actual valueFor an ECS Cluster layer, AWS OpsWorks the
EcsClusterArn
attribute is set to the cluster's ARN.
-
withAttributes
The layer attributes.
For the
HaproxyStatsPassword
,MysqlRootPassword
, andGangliaPassword
attributes, AWS OpsWorks returns*****FILTERED*****
instead of the actual valueFor an ECS Cluster layer, AWS OpsWorks the
EcsClusterArn
attribute is set to the cluster's ARN.- Parameters:
attributes
- The layer attributes.For the
HaproxyStatsPassword
,MysqlRootPassword
, andGangliaPassword
attributes, AWS OpsWorks returns*****FILTERED*****
instead of the actual valueFor an ECS Cluster layer, AWS OpsWorks the
EcsClusterArn
attribute is set to the cluster's ARN.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
addAttributesEntry
-
clearAttributesEntries
Removes all the entries added into Attributes. <p> Returns a reference to this object so that method calls can be chained together. -
setCustomInstanceProfileArn
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.
-
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.
-
withCustomInstanceProfileArn
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCustomJson
A JSON formatted string containing the layer's custom stack configuration and deployment attributes.
- Parameters:
customJson
- A JSON formatted string containing the layer's custom stack configuration and deployment attributes.
-
getCustomJson
A JSON formatted string containing the layer's custom stack configuration and deployment attributes.
- Returns:
- A JSON formatted string containing the layer's custom stack configuration and deployment attributes.
-
withCustomJson
A JSON formatted string containing the layer's custom stack configuration and deployment attributes.
- Parameters:
customJson
- A JSON formatted string containing the layer's custom stack configuration and deployment attributes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getCustomSecurityGroupIds
An array containing the layer's custom security group IDs.
- Returns:
- An array containing the layer's custom security group IDs.
-
setCustomSecurityGroupIds
An array containing the layer's custom security group IDs.
- Parameters:
customSecurityGroupIds
- An array containing the layer's custom security group IDs.
-
withCustomSecurityGroupIds
An array containing the layer's custom security group IDs.
NOTE: This method appends the values to the existing list (if any). Use
setCustomSecurityGroupIds(java.util.Collection)
orwithCustomSecurityGroupIds(java.util.Collection)
if you want to override the existing values.- Parameters:
customSecurityGroupIds
- An array containing the layer's custom security group IDs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withCustomSecurityGroupIds
An array containing the layer's custom security group IDs.
- Parameters:
customSecurityGroupIds
- An array containing the layer's custom security group IDs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getDefaultSecurityGroupNames
An array containing the layer's security group names.
- Returns:
- An array containing the layer's security group names.
-
setDefaultSecurityGroupNames
An array containing the layer's security group names.
- Parameters:
defaultSecurityGroupNames
- An array containing the layer's security group names.
-
withDefaultSecurityGroupNames
An array containing the layer's security group names.
NOTE: This method appends the values to the existing list (if any). Use
setDefaultSecurityGroupNames(java.util.Collection)
orwithDefaultSecurityGroupNames(java.util.Collection)
if you want to override the existing values.- Parameters:
defaultSecurityGroupNames
- An array containing the layer's security group names.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withDefaultSecurityGroupNames
An array containing the layer's security group names.
- Parameters:
defaultSecurityGroupNames
- An array containing the layer's security group names.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
An array of
Package
objects that describe the layer's packages.- Parameters:
packages
- An array ofPackage
objects that describe the layer's packages.
-
withPackages
An array of
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)
orwithPackages(java.util.Collection)
if you want to override the existing values.- Parameters:
packages
- An array ofPackage
objects that describe the layer's packages.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withPackages
An array of
Package
objects that describe the layer's packages.- Parameters:
packages
- An array ofPackage
objects that describe the layer's packages.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
A
VolumeConfigurations
object that describes the layer's Amazon EBS volumes.- Parameters:
volumeConfigurations
- AVolumeConfigurations
object that describes the layer's Amazon EBS volumes.
-
withVolumeConfigurations
A
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)
orwithVolumeConfigurations(java.util.Collection)
if you want to override the existing values.- Parameters:
volumeConfigurations
- AVolumeConfigurations
object that describes the layer's Amazon EBS volumes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withVolumeConfigurations
A
VolumeConfigurations
object that describes the layer's Amazon EBS volumes.- Parameters:
volumeConfigurations
- AVolumeConfigurations
object that describes the layer's Amazon EBS volumes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEnableAutoHealing
Whether auto healing is disabled for the layer.
- Parameters:
enableAutoHealing
- Whether auto healing is disabled for the layer.
-
getEnableAutoHealing
Whether auto healing is disabled for the layer.
- Returns:
- Whether auto healing is disabled for the layer.
-
withEnableAutoHealing
Whether auto healing is disabled for the layer.
- Parameters:
enableAutoHealing
- Whether auto healing is disabled for the layer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isEnableAutoHealing
Whether auto healing is disabled for the layer.
- Returns:
- Whether auto healing is disabled for the layer.
-
setAutoAssignElasticIps
Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
- Parameters:
autoAssignElasticIps
- Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
-
getAutoAssignElasticIps
Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
- Returns:
- Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
-
withAutoAssignElasticIps
Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
- Parameters:
autoAssignElasticIps
- Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isAutoAssignElasticIps
Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
- Returns:
- Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
-
setAutoAssignPublicIps
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.
- Parameters:
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.
-
getAutoAssignPublicIps
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.
- Returns:
- 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.
-
withAutoAssignPublicIps
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isAutoAssignPublicIps
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.
- Returns:
- 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.
-
setDefaultRecipes
- Parameters:
defaultRecipes
-
-
getDefaultRecipes
- Returns:
-
withDefaultRecipes
- Parameters:
defaultRecipes
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCustomRecipes
A
LayerCustomRecipes
object that specifies the layer's custom recipes.- Parameters:
customRecipes
- ALayerCustomRecipes
object that specifies the layer's custom recipes.
-
getCustomRecipes
A
LayerCustomRecipes
object that specifies the layer's custom recipes.- Returns:
- A
LayerCustomRecipes
object that specifies the layer's custom recipes.
-
withCustomRecipes
A
LayerCustomRecipes
object that specifies the layer's custom recipes.- Parameters:
customRecipes
- ALayerCustomRecipes
object that specifies the layer's custom recipes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCreatedAt
Date when the layer was created.
- Parameters:
createdAt
- Date when the layer was created.
-
getCreatedAt
Date when the layer was created.
- Returns:
- Date when the layer was created.
-
withCreatedAt
Date when the layer was created.
- Parameters:
createdAt
- Date when the layer was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setInstallUpdatesOnBoot
Whether to install operating system and package updates when the instance boots. The default value is
true
. If this value is set tofalse
, you must then update your instances manually by using CreateDeployment to run theupdate_dependencies
stack command or manually runningyum
(Amazon Linux) orapt-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 istrue
. If this value is set tofalse
, you must then update your instances manually by using CreateDeployment to run theupdate_dependencies
stack command or manually runningyum
(Amazon Linux) orapt-get
(Ubuntu) on the instances.We strongly recommend using the default value of
true
, to ensure that your instances have the latest security updates.
-
getInstallUpdatesOnBoot
Whether to install operating system and package updates when the instance boots. The default value is
true
. If this value is set tofalse
, you must then update your instances manually by using CreateDeployment to run theupdate_dependencies
stack command or manually runningyum
(Amazon Linux) orapt-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
. If this value is set tofalse
, you must then update your instances manually by using CreateDeployment to run theupdate_dependencies
stack command or manually runningyum
(Amazon Linux) orapt-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
Whether to install operating system and package updates when the instance boots. The default value is
true
. If this value is set tofalse
, you must then update your instances manually by using CreateDeployment to run theupdate_dependencies
stack command or manually runningyum
(Amazon Linux) orapt-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 istrue
. If this value is set tofalse
, you must then update your instances manually by using CreateDeployment to run theupdate_dependencies
stack command or manually runningyum
(Amazon Linux) orapt-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:
- Returns a reference to this object so that method calls can be chained together.
-
isInstallUpdatesOnBoot
Whether to install operating system and package updates when the instance boots. The default value is
true
. If this value is set tofalse
, you must then update your instances manually by using CreateDeployment to run theupdate_dependencies
stack command or manually runningyum
(Amazon Linux) orapt-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
. If this value is set tofalse
, you must then update your instances manually by using CreateDeployment to run theupdate_dependencies
stack command or manually runningyum
(Amazon Linux) orapt-get
(Ubuntu) on the instances.We strongly recommend using the default value of
true
, to ensure that your instances have the latest security updates.
-
setUseEbsOptimizedInstances
Whether the layer uses Amazon EBS-optimized instances.
- Parameters:
useEbsOptimizedInstances
- Whether the layer uses Amazon EBS-optimized instances.
-
getUseEbsOptimizedInstances
Whether the layer uses Amazon EBS-optimized instances.
- Returns:
- Whether the layer uses Amazon EBS-optimized instances.
-
withUseEbsOptimizedInstances
Whether the layer uses Amazon EBS-optimized instances.
- Parameters:
useEbsOptimizedInstances
- Whether the layer uses Amazon EBS-optimized instances.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isUseEbsOptimizedInstances
Whether the layer uses Amazon EBS-optimized instances.
- Returns:
- Whether the layer uses Amazon EBS-optimized instances.
-
setLifecycleEventConfiguration
A
LifeCycleEventConfiguration
object that specifies the Shutdown event configuration.- Parameters:
lifecycleEventConfiguration
- ALifeCycleEventConfiguration
object that specifies the Shutdown event configuration.
-
getLifecycleEventConfiguration
A
LifeCycleEventConfiguration
object that specifies the Shutdown event configuration.- Returns:
- A
LifeCycleEventConfiguration
object that specifies the Shutdown event configuration.
-
withLifecycleEventConfiguration
public Layer withLifecycleEventConfiguration(LifecycleEventConfiguration lifecycleEventConfiguration) A
LifeCycleEventConfiguration
object that specifies the Shutdown event configuration.- Parameters:
lifecycleEventConfiguration
- ALifeCycleEventConfiguration
object that specifies the Shutdown event configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-