Package com.amazonaws.services.opsworks.model

Class CreateLayerRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.opsworks.model.CreateLayerRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable
public class CreateLayerRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
See Also:

  • Constructor Details

    • CreateLayerRequest

      public CreateLayerRequest()

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

    • setType

      public void setType(String type)

      The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers.

      Parameters:
      type - The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers.
      See Also:

    • getType

      public String getType()

      The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers.

      Returns:
      The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers.
      See Also:

    • withType

      public CreateLayerRequest withType(String type)

      The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers.

      Parameters:
      type - The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers.
      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. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers.

      Parameters:
      type - The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers.
      See Also:

    • withType

      public CreateLayerRequest withType(LayerType type)

      The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers.

      Parameters:
      type - The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers.
      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, which is used by the console.

      Parameters:
      name - The layer name, which is used by the console.

    • getName

      public String getName()

      The layer name, which is used by the console.

      Returns:
      The layer name, which is used by the console.

    • withName

      public CreateLayerRequest withName(String name)

      The layer name, which is used by the console.

      Parameters:
      name - The layer name, which is used by the console.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setShortname

      public void setShortname(String shortname)

      For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks and by Chef recipes. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric characters, '-', '_', and '.'.

      The built-in layers' short names are defined by AWS OpsWorks. For more information, see the Layer Reference.

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

      The built-in layers' short names are defined by AWS OpsWorks. For more information, see the Layer Reference.

    • getShortname

      public String getShortname()

      For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks and by Chef recipes. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric characters, '-', '_', and '.'.

      The built-in layers' short names are defined by AWS OpsWorks. For more information, see the Layer Reference.

      Returns:
      For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks and by Chef recipes. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric characters, '-', '_', and '.'.

      The built-in layers' short names are defined by AWS OpsWorks. For more information, see the Layer Reference.

    • withShortname

      public CreateLayerRequest withShortname(String shortname)

      For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks and by Chef recipes. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric characters, '-', '_', and '.'.

      The built-in layers' short names are defined by AWS OpsWorks. For more information, see the Layer Reference.

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

      The built-in layers' short names are defined by AWS OpsWorks. For more information, see the Layer Reference.

      Returns:
      Returns a reference to this 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.

      To create a cluster layer, set the EcsClusterArn attribute to the cluster's ARN.

      Returns:
      One or more user-defined key-value pairs to be added to the stack attributes.

      To create a cluster layer, set the EcsClusterArn attribute to the cluster's ARN.

    • setAttributes

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

      One or more user-defined key-value pairs to be added to the stack attributes.

      To create a cluster layer, set the EcsClusterArn attribute to the cluster's ARN.

      Parameters:
      attributes - One or more user-defined key-value pairs to be added to the stack attributes.

      To create a cluster layer, set the EcsClusterArn attribute to the cluster's ARN.

    • withAttributes

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

      One or more user-defined key-value pairs to be added to the stack attributes.

      To create a cluster layer, set the EcsClusterArn attribute to the cluster's ARN.

      Parameters:
      attributes - One or more user-defined key-value pairs to be added to the stack attributes.

      To create a cluster layer, set the EcsClusterArn attribute to the cluster's ARN.

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

    • addAttributesEntry

      public CreateLayerRequest addAttributesEntry(String key, String value)

    • clearAttributesEntries

      public CreateLayerRequest 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 an 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 an 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 an IAM profile 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 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 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 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 custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see Using Custom JSON. This feature is supported as of version 1.7.42 of the AWS CLI.

      Parameters:
      customJson - A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see Using Custom JSON. This feature is supported as of version 1.7.42 of the AWS CLI.

    • getCustomJson

      public String getCustomJson()

      A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see Using Custom JSON. This feature is supported as of version 1.7.42 of the AWS CLI.

      Returns:
      A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see Using Custom JSON. This feature is supported as of version 1.7.42 of the AWS CLI.

    • withCustomJson

      public CreateLayerRequest withCustomJson(String customJson)

      A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see Using Custom JSON. This feature is supported as of version 1.7.42 of the AWS CLI.

      Parameters:
      customJson - A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see Using Custom JSON. This feature is supported as of version 1.7.42 of the AWS CLI.
      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 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.

      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 custom security group IDs.
      Returns:
      Returns a reference to this 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.

      Parameters:
      customSecurityGroupIds - An array containing the layer custom security group IDs.
      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 describes the layer packages.

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

    • setPackages

      public void setPackages(Collection<String> packages)

      An array of Package objects that describes the layer packages.

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

    • withPackages

      public CreateLayerRequest withPackages(String... packages)

      An array of Package objects that describes the layer 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 describes the layer packages.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • withPackages

      public CreateLayerRequest withPackages(Collection<String> packages)

      An array of Package objects that describes the layer packages.

      Parameters:
      packages - An array of Package objects that describes the layer 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 CreateLayerRequest 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 CreateLayerRequest 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 to disable auto healing for the layer.

      Parameters:
      enableAutoHealing - Whether to disable auto healing for the layer.

    • getEnableAutoHealing

      public Boolean getEnableAutoHealing()

      Whether to disable auto healing for the layer.

      Returns:
      Whether to disable auto healing for the layer.

    • withEnableAutoHealing

      public CreateLayerRequest withEnableAutoHealing(Boolean enableAutoHealing)

      Whether to disable auto healing for the layer.

      Parameters:
      enableAutoHealing - Whether to disable auto healing for the layer.
      Returns:
      Returns a reference to this 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.

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

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

    • getCustomRecipes

      public Recipes getCustomRecipes()

      A LayerCustomRecipes object that specifies the layer custom recipes.

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

    • withCustomRecipes

      public CreateLayerRequest withCustomRecipes(Recipes customRecipes)

      A LayerCustomRecipes object that specifies the layer custom recipes.

      Parameters:
      customRecipes - A LayerCustomRecipes object that specifies the layer custom recipes.
      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. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

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

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

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

    • getInstallUpdatesOnBoot

      public Boolean getInstallUpdatesOnBoot()

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

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

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

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

    • withInstallUpdatesOnBoot

      public CreateLayerRequest withInstallUpdatesOnBoot(Boolean installUpdatesOnBoot)

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

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

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

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

      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. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

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

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

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

    • setUseEbsOptimizedInstances

      public void setUseEbsOptimizedInstances(Boolean useEbsOptimizedInstances)

      Whether to use Amazon EBS-optimized instances.

      Parameters:
      useEbsOptimizedInstances - Whether to use Amazon EBS-optimized instances.

    • getUseEbsOptimizedInstances

      public Boolean getUseEbsOptimizedInstances()

      Whether to use Amazon EBS-optimized instances.

      Returns:
      Whether to use Amazon EBS-optimized instances.

    • withUseEbsOptimizedInstances

      public CreateLayerRequest withUseEbsOptimizedInstances(Boolean useEbsOptimizedInstances)

      Whether to use Amazon EBS-optimized instances.

      Parameters:
      useEbsOptimizedInstances - Whether to use Amazon EBS-optimized instances.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isUseEbsOptimizedInstances

      public Boolean isUseEbsOptimizedInstances()

      Whether to use Amazon EBS-optimized instances.

      Returns:
      Whether to use Amazon EBS-optimized instances.

    • setLifecycleEventConfiguration

      public void setLifecycleEventConfiguration(LifecycleEventConfiguration lifecycleEventConfiguration)

      A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.

      Parameters:
      lifecycleEventConfiguration - A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.

    • getLifecycleEventConfiguration

      public LifecycleEventConfiguration getLifecycleEventConfiguration()

      A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.

      Returns:
      A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.

    • withLifecycleEventConfiguration

      public CreateLayerRequest withLifecycleEventConfiguration(LifecycleEventConfiguration lifecycleEventConfiguration)

      A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.

      Parameters:
      lifecycleEventConfiguration - A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.
      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 CreateLayerRequest clone()
      Description copied from class: AmazonWebServiceRequest
      Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: