Package com.amazonaws.services.opsworks.model

Class Layer

java.lang.Object
com.amazonaws.services.opsworks.model.Layer
All Implemented Interfaces:
Serializable, Cloneable
public class Layer extends Object implements Serializable, Cloneable

Describes a layer.

See Also:

  • Constructor Details

    • Layer

      public Layer()

  • Method Details

    • setStackId

      public void setStackId(String stackId)

      The layer stack ID.

      Parameters:
      stackId - The layer stack ID.

    • getStackId

      public String getStackId()

      The layer stack ID.

      Returns:
      The layer stack ID.

    • withStackId

      public Layer withStackId(String stackId)

      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

      public void setLayerId(String layerId)

      The layer ID.

      Parameters:
      layerId - The layer ID.

    • getLayerId

      public String getLayerId()

      The layer ID.

      Returns:
      The layer ID.

    • withLayerId

      public Layer withLayerId(String layerId)

      The layer ID.

      Parameters:
      layerId - The layer ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setType

      public void setType(String type)

      The layer type.

      Parameters:
      type - The layer type.
      See Also:

    • getType

      public String getType()

      The layer type.

      Returns:
      The layer type.
      See Also:

    • withType

      public Layer withType(String type)

      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

      public void setType(LayerType type)

      The layer type.

      Parameters:
      type - The layer type.
      See Also:

    • withType

      public Layer withType(LayerType type)

      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

      public void setName(String name)

      The layer name.

      Parameters:
      name - The layer name.

    • getName

      public String getName()

      The layer name.

      Returns:
      The layer name.

    • withName

      public Layer withName(String name)

      The layer name.

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

    • setShortname

      public void setShortname(String shortname)

      The layer short name.

      Parameters:
      shortname - The layer short name.

    • getShortname

      public String getShortname()

      The layer short name.

      Returns:
      The layer short name.

    • withShortname

      public Layer withShortname(String shortname)

      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

      public Map<String,String> getAttributes()

      The layer attributes.

      For the HaproxyStatsPassword, MysqlRootPassword , and GangliaPassword attributes, AWS OpsWorks returns *****FILTERED***** instead of the actual value

      For an ECS Cluster layer, AWS OpsWorks the EcsClusterArn attribute is set to the cluster's ARN.

      Returns:
      The layer attributes.

      For the HaproxyStatsPassword, MysqlRootPassword, and GangliaPassword attributes, AWS OpsWorks returns *****FILTERED***** instead of the actual value

      For an ECS Cluster layer, AWS OpsWorks the EcsClusterArn attribute is set to the cluster's ARN.

    • setAttributes

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

      The layer attributes.

      For the HaproxyStatsPassword, MysqlRootPassword , and GangliaPassword attributes, AWS OpsWorks returns *****FILTERED***** instead of the actual value

      For 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, and GangliaPassword attributes, AWS OpsWorks returns *****FILTERED***** instead of the actual value

      For an ECS Cluster layer, AWS OpsWorks the EcsClusterArn attribute is set to the cluster's ARN.

    • withAttributes

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

      The layer attributes.

      For the HaproxyStatsPassword, MysqlRootPassword , and GangliaPassword attributes, AWS OpsWorks returns *****FILTERED***** instead of the actual value

      For 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, and GangliaPassword attributes, AWS OpsWorks returns *****FILTERED***** instead of the actual value

      For 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

      public Layer addAttributesEntry(String key, String value)

    • clearAttributesEntries

      public Layer clearAttributesEntries()
      Removes all the entries added into Attributes. <p> Returns a reference to this object so that method calls can be chained together.

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

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

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

      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

      public void setCustomJson(String customJson)

      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

      public String 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

      public Layer withCustomJson(String customJson)

      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

      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.

      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.

      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

      public Layer withCustomSecurityGroupIds(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.
      Returns:
      Returns a reference to this 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.

      NOTE: This method appends the values to the existing list (if any). Use setDefaultSecurityGroupNames(java.util.Collection) or withDefaultSecurityGroupNames(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

      public Layer withDefaultSecurityGroupNames(Collection<String> defaultSecurityGroupNames)

      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

      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.

      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.

      Parameters:
      packages - An array of Package objects that describe the layer's packages.
      Returns:
      Returns a reference to this 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.

      Parameters:
      packages - An array of Package objects that describe the layer's packages.
      Returns:
      Returns a reference to this 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.

      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.

      Parameters:
      volumeConfigurations - A VolumeConfigurations 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

      public Layer withVolumeConfigurations(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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setEnableAutoHealing

      public void setEnableAutoHealing(Boolean enableAutoHealing)

      Whether auto healing is disabled for the layer.

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

    • getEnableAutoHealing

      public Boolean getEnableAutoHealing()

      Whether auto healing is disabled for the layer.

      Returns:
      Whether auto healing is disabled for the layer.

    • withEnableAutoHealing

      public Layer withEnableAutoHealing(Boolean enableAutoHealing)

      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

      public Boolean isEnableAutoHealing()

      Whether auto healing is disabled for the layer.

      Returns:
      Whether auto healing is disabled for the layer.

    • setAutoAssignElasticIps

      public void setAutoAssignElasticIps(Boolean autoAssignElasticIps)

      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

      public Boolean 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

      public Layer withAutoAssignElasticIps(Boolean autoAssignElasticIps)

      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

      public Boolean 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

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

      public Boolean 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

      public Layer withAutoAssignPublicIps(Boolean 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.

      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

      public Boolean 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

      public void setDefaultRecipes(Recipes defaultRecipes)
      Parameters:
      defaultRecipes -

    • getDefaultRecipes

      public Recipes getDefaultRecipes()
      Returns:

    • withDefaultRecipes

      public Layer withDefaultRecipes(Recipes defaultRecipes)
      Parameters:
      defaultRecipes -
      Returns:
      Returns a reference to this object so that method calls can be chained together.

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

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

    • withCustomRecipes

      public Layer withCustomRecipes(Recipes customRecipes)

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

      Parameters:
      customRecipes - A LayerCustomRecipes object that specifies the layer's custom recipes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setCreatedAt

      public void setCreatedAt(String createdAt)

      Date when the layer was created.

      Parameters:
      createdAt - Date when the layer was created.

    • getCreatedAt

      public String getCreatedAt()

      Date when the layer was created.

      Returns:
      Date when the layer was created.

    • withCreatedAt

      public Layer withCreatedAt(String createdAt)

      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

      public void setInstallUpdatesOnBoot(Boolean installUpdatesOnBoot)

      Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set to false, you must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

      We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.

      Parameters:
      installUpdatesOnBoot - Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set 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.

    • getInstallUpdatesOnBoot

      public Boolean getInstallUpdatesOnBoot()

      Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set to false, you must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

      We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.

      Returns:
      Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set to false, you must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

      We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.

    • withInstallUpdatesOnBoot

      public Layer withInstallUpdatesOnBoot(Boolean installUpdatesOnBoot)

      Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set to false, you must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

      We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.

      Parameters:
      installUpdatesOnBoot - Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set 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:
      Returns a reference to this object so that method calls can be chained together.

    • isInstallUpdatesOnBoot

      public Boolean isInstallUpdatesOnBoot()

      Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set to false, you must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

      We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.

      Returns:
      Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set 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.

    • setUseEbsOptimizedInstances

      public void setUseEbsOptimizedInstances(Boolean useEbsOptimizedInstances)

      Whether the layer uses Amazon EBS-optimized instances.

      Parameters:
      useEbsOptimizedInstances - Whether the layer uses Amazon EBS-optimized instances.

    • getUseEbsOptimizedInstances

      public Boolean getUseEbsOptimizedInstances()

      Whether the layer uses Amazon EBS-optimized instances.

      Returns:
      Whether the layer uses Amazon EBS-optimized instances.

    • withUseEbsOptimizedInstances

      public Layer withUseEbsOptimizedInstances(Boolean useEbsOptimizedInstances)

      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

      public Boolean isUseEbsOptimizedInstances()

      Whether the layer uses Amazon EBS-optimized instances.

      Returns:
      Whether the layer uses Amazon EBS-optimized instances.

    • setLifecycleEventConfiguration

      public void setLifecycleEventConfiguration(LifecycleEventConfiguration lifecycleEventConfiguration)

      A LifeCycleEventConfiguration object that specifies the Shutdown event configuration.

      Parameters:
      lifecycleEventConfiguration - A LifeCycleEventConfiguration object that specifies the Shutdown event configuration.

    • getLifecycleEventConfiguration

      public LifecycleEventConfiguration 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 - A LifeCycleEventConfiguration object that specifies the Shutdown event configuration.
      Returns:
      Returns a reference to this 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:

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • clone

      public Layer clone()
      Overrides:
      clone in class Object