java.lang.Object
com.amazonaws.services.opsworks.model.Stack
All Implemented Interfaces:
Serializable, Cloneable

public class Stack extends Object implements Serializable, Cloneable

Describes a stack.

See Also:
  • Constructor Details

    • Stack

      public Stack()
  • Method Details

    • setStackId

      public void setStackId(String stackId)

      The stack ID.

      Parameters:
      stackId - The stack ID.
    • getStackId

      public String getStackId()

      The stack ID.

      Returns:
      The stack ID.
    • withStackId

      public Stack withStackId(String stackId)

      The stack ID.

      Parameters:
      stackId - The stack ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setName

      public void setName(String name)

      The stack name.

      Parameters:
      name - The stack name.
    • getName

      public String getName()

      The stack name.

      Returns:
      The stack name.
    • withName

      public Stack withName(String name)

      The stack name.

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

      public void setArn(String arn)

      The stack's ARN.

      Parameters:
      arn - The stack's ARN.
    • getArn

      public String getArn()

      The stack's ARN.

      Returns:
      The stack's ARN.
    • withArn

      public Stack withArn(String arn)

      The stack's ARN.

      Parameters:
      arn - The stack's ARN.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setRegion

      public void setRegion(String region)

      The stack AWS region, such as "us-east-1". For more information about AWS regions, see Regions and Endpoints.

      Parameters:
      region - The stack AWS region, such as "us-east-1". For more information about AWS regions, see Regions and Endpoints.
    • getRegion

      public String getRegion()

      The stack AWS region, such as "us-east-1". For more information about AWS regions, see Regions and Endpoints.

      Returns:
      The stack AWS region, such as "us-east-1". For more information about AWS regions, see Regions and Endpoints.
    • withRegion

      public Stack withRegion(String region)

      The stack AWS region, such as "us-east-1". For more information about AWS regions, see Regions and Endpoints.

      Parameters:
      region - The stack AWS region, such as "us-east-1". For more information about AWS regions, see Regions and Endpoints.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setVpcId

      public void setVpcId(String vpcId)

      The VPC ID; applicable only if the stack is running in a VPC.

      Parameters:
      vpcId - The VPC ID; applicable only if the stack is running in a VPC.
    • getVpcId

      public String getVpcId()

      The VPC ID; applicable only if the stack is running in a VPC.

      Returns:
      The VPC ID; applicable only if the stack is running in a VPC.
    • withVpcId

      public Stack withVpcId(String vpcId)

      The VPC ID; applicable only if the stack is running in a VPC.

      Parameters:
      vpcId - The VPC ID; applicable only if the stack is running in a VPC.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • getAttributes

      public Map<String,String> getAttributes()

      The stack's attributes.

      Returns:
      The stack's attributes.
    • setAttributes

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

      The stack's attributes.

      Parameters:
      attributes - The stack's attributes.
    • withAttributes

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

      The stack's attributes.

      Parameters:
      attributes - The stack's attributes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • addAttributesEntry

      public Stack addAttributesEntry(String key, String value)
    • clearAttributesEntries

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

      public void setServiceRoleArn(String serviceRoleArn)

      The stack AWS Identity and Access Management (IAM) role.

      Parameters:
      serviceRoleArn - The stack AWS Identity and Access Management (IAM) role.
    • getServiceRoleArn

      public String getServiceRoleArn()

      The stack AWS Identity and Access Management (IAM) role.

      Returns:
      The stack AWS Identity and Access Management (IAM) role.
    • withServiceRoleArn

      public Stack withServiceRoleArn(String serviceRoleArn)

      The stack AWS Identity and Access Management (IAM) role.

      Parameters:
      serviceRoleArn - The stack AWS Identity and Access Management (IAM) role.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setDefaultInstanceProfileArn

      public void setDefaultInstanceProfileArn(String defaultInstanceProfileArn)

      The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

      Parameters:
      defaultInstanceProfileArn - The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
    • getDefaultInstanceProfileArn

      public String getDefaultInstanceProfileArn()

      The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

      Returns:
      The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
    • withDefaultInstanceProfileArn

      public Stack withDefaultInstanceProfileArn(String defaultInstanceProfileArn)

      The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

      Parameters:
      defaultInstanceProfileArn - The ARN of an IAM profile that is the default profile for all of the stack'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.
    • setDefaultOs

      public void setDefaultOs(String defaultOs)

      The stack's default operating system.

      Parameters:
      defaultOs - The stack's default operating system.
    • getDefaultOs

      public String getDefaultOs()

      The stack's default operating system.

      Returns:
      The stack's default operating system.
    • withDefaultOs

      public Stack withDefaultOs(String defaultOs)

      The stack's default operating system.

      Parameters:
      defaultOs - The stack's default operating system.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setHostnameTheme

      public void setHostnameTheme(String hostnameTheme)

      The stack host name theme, with spaces replaced by underscores.

      Parameters:
      hostnameTheme - The stack host name theme, with spaces replaced by underscores.
    • getHostnameTheme

      public String getHostnameTheme()

      The stack host name theme, with spaces replaced by underscores.

      Returns:
      The stack host name theme, with spaces replaced by underscores.
    • withHostnameTheme

      public Stack withHostnameTheme(String hostnameTheme)

      The stack host name theme, with spaces replaced by underscores.

      Parameters:
      hostnameTheme - The stack host name theme, with spaces replaced by underscores.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setDefaultAvailabilityZone

      public void setDefaultAvailabilityZone(String defaultAvailabilityZone)

      The stack's default Availability Zone. For more information, see Regions and Endpoints.

      Parameters:
      defaultAvailabilityZone - The stack's default Availability Zone. For more information, see Regions and Endpoints.
    • getDefaultAvailabilityZone

      public String getDefaultAvailabilityZone()

      The stack's default Availability Zone. For more information, see Regions and Endpoints.

      Returns:
      The stack's default Availability Zone. For more information, see Regions and Endpoints.
    • withDefaultAvailabilityZone

      public Stack withDefaultAvailabilityZone(String defaultAvailabilityZone)

      The stack's default Availability Zone. For more information, see Regions and Endpoints.

      Parameters:
      defaultAvailabilityZone - The stack's default Availability Zone. For more information, see Regions and Endpoints.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setDefaultSubnetId

      public void setDefaultSubnetId(String defaultSubnetId)

      The default subnet ID; applicable only if the stack is running in a VPC.

      Parameters:
      defaultSubnetId - The default subnet ID; applicable only if the stack is running in a VPC.
    • getDefaultSubnetId

      public String getDefaultSubnetId()

      The default subnet ID; applicable only if the stack is running in a VPC.

      Returns:
      The default subnet ID; applicable only if the stack is running in a VPC.
    • withDefaultSubnetId

      public Stack withDefaultSubnetId(String defaultSubnetId)

      The default subnet ID; applicable only if the stack is running in a VPC.

      Parameters:
      defaultSubnetId - The default subnet ID; applicable only if the stack is running in a VPC.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setCustomJson

      public void setCustomJson(String customJson)

      A JSON object that contains user-defined attributes to be added to the stack configuration and deployment attributes. You can use custom JSON to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format and must escape characters such as '"':

      "{\"key1\": \"value1\", \"key2\": \"value2\",...}"

      For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

      Parameters:
      customJson - A JSON object that contains user-defined attributes to be added to the stack configuration and deployment attributes. You can use custom JSON to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format and must escape characters such as '"':

      "{\"key1\": \"value1\", \"key2\": \"value2\",...}"

      For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

    • getCustomJson

      public String getCustomJson()

      A JSON object that contains user-defined attributes to be added to the stack configuration and deployment attributes. You can use custom JSON to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format and must escape characters such as '"':

      "{\"key1\": \"value1\", \"key2\": \"value2\",...}"

      For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

      Returns:
      A JSON object that contains user-defined attributes to be added to the stack configuration and deployment attributes. You can use custom JSON to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format and must escape characters such as '"':

      "{\"key1\": \"value1\", \"key2\": \"value2\",...}"

      For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

    • withCustomJson

      public Stack withCustomJson(String customJson)

      A JSON object that contains user-defined attributes to be added to the stack configuration and deployment attributes. You can use custom JSON to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format and must escape characters such as '"':

      "{\"key1\": \"value1\", \"key2\": \"value2\",...}"

      For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

      Parameters:
      customJson - A JSON object that contains user-defined attributes to be added to the stack configuration and deployment attributes. You can use custom JSON to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format and must escape characters such as '"':

      "{\"key1\": \"value1\", \"key2\": \"value2\",...}"

      For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

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

      public void setConfigurationManager(StackConfigurationManager configurationManager)

      The configuration manager.

      Parameters:
      configurationManager - The configuration manager.
    • getConfigurationManager

      public StackConfigurationManager getConfigurationManager()

      The configuration manager.

      Returns:
      The configuration manager.
    • withConfigurationManager

      public Stack withConfigurationManager(StackConfigurationManager configurationManager)

      The configuration manager.

      Parameters:
      configurationManager - The configuration manager.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setChefConfiguration

      public void setChefConfiguration(ChefConfiguration chefConfiguration)

      A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version. For more information, see Create a New Stack.

      Parameters:
      chefConfiguration - A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version. For more information, see Create a New Stack.
    • getChefConfiguration

      public ChefConfiguration getChefConfiguration()

      A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version. For more information, see Create a New Stack.

      Returns:
      A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version. For more information, see Create a New Stack.
    • withChefConfiguration

      public Stack withChefConfiguration(ChefConfiguration chefConfiguration)

      A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version. For more information, see Create a New Stack.

      Parameters:
      chefConfiguration - A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version. For more information, see Create a New Stack.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setUseCustomCookbooks

      public void setUseCustomCookbooks(Boolean useCustomCookbooks)

      Whether the stack uses custom cookbooks.

      Parameters:
      useCustomCookbooks - Whether the stack uses custom cookbooks.
    • getUseCustomCookbooks

      public Boolean getUseCustomCookbooks()

      Whether the stack uses custom cookbooks.

      Returns:
      Whether the stack uses custom cookbooks.
    • withUseCustomCookbooks

      public Stack withUseCustomCookbooks(Boolean useCustomCookbooks)

      Whether the stack uses custom cookbooks.

      Parameters:
      useCustomCookbooks - Whether the stack uses custom cookbooks.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isUseCustomCookbooks

      public Boolean isUseCustomCookbooks()

      Whether the stack uses custom cookbooks.

      Returns:
      Whether the stack uses custom cookbooks.
    • setUseOpsworksSecurityGroups

      public void setUseOpsworksSecurityGroups(Boolean useOpsworksSecurityGroups)

      Whether the stack automatically associates the AWS OpsWorks built-in security groups with the stack's layers.

      Parameters:
      useOpsworksSecurityGroups - Whether the stack automatically associates the AWS OpsWorks built-in security groups with the stack's layers.
    • getUseOpsworksSecurityGroups

      public Boolean getUseOpsworksSecurityGroups()

      Whether the stack automatically associates the AWS OpsWorks built-in security groups with the stack's layers.

      Returns:
      Whether the stack automatically associates the AWS OpsWorks built-in security groups with the stack's layers.
    • withUseOpsworksSecurityGroups

      public Stack withUseOpsworksSecurityGroups(Boolean useOpsworksSecurityGroups)

      Whether the stack automatically associates the AWS OpsWorks built-in security groups with the stack's layers.

      Parameters:
      useOpsworksSecurityGroups - Whether the stack automatically associates the AWS OpsWorks built-in security groups with the stack's layers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isUseOpsworksSecurityGroups

      public Boolean isUseOpsworksSecurityGroups()

      Whether the stack automatically associates the AWS OpsWorks built-in security groups with the stack's layers.

      Returns:
      Whether the stack automatically associates the AWS OpsWorks built-in security groups with the stack's layers.
    • setCustomCookbooksSource

      public void setCustomCookbooksSource(Source customCookbooksSource)
      Parameters:
      customCookbooksSource -
    • getCustomCookbooksSource

      public Source getCustomCookbooksSource()
      Returns:
    • withCustomCookbooksSource

      public Stack withCustomCookbooksSource(Source customCookbooksSource)
      Parameters:
      customCookbooksSource -
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setDefaultSshKeyName

      public void setDefaultSshKeyName(String defaultSshKeyName)

      A default Amazon EC2 key pair for the stack's instances. You can override this value when you create or update an instance.

      Parameters:
      defaultSshKeyName - A default Amazon EC2 key pair for the stack's instances. You can override this value when you create or update an instance.
    • getDefaultSshKeyName

      public String getDefaultSshKeyName()

      A default Amazon EC2 key pair for the stack's instances. You can override this value when you create or update an instance.

      Returns:
      A default Amazon EC2 key pair for the stack's instances. You can override this value when you create or update an instance.
    • withDefaultSshKeyName

      public Stack withDefaultSshKeyName(String defaultSshKeyName)

      A default Amazon EC2 key pair for the stack's instances. You can override this value when you create or update an instance.

      Parameters:
      defaultSshKeyName - A default Amazon EC2 key pair for the stack's instances. You can override this value when you create or update an instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setCreatedAt

      public void setCreatedAt(String createdAt)

      The date when the stack was created.

      Parameters:
      createdAt - The date when the stack was created.
    • getCreatedAt

      public String getCreatedAt()

      The date when the stack was created.

      Returns:
      The date when the stack was created.
    • withCreatedAt

      public Stack withCreatedAt(String createdAt)

      The date when the stack was created.

      Parameters:
      createdAt - The date when the stack was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setDefaultRootDeviceType

      public void setDefaultRootDeviceType(String defaultRootDeviceType)

      The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.

      Parameters:
      defaultRootDeviceType - The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.
      See Also:
    • getDefaultRootDeviceType

      public String getDefaultRootDeviceType()

      The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.

      Returns:
      The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.
      See Also:
    • withDefaultRootDeviceType

      public Stack withDefaultRootDeviceType(String defaultRootDeviceType)

      The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.

      Parameters:
      defaultRootDeviceType - The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setDefaultRootDeviceType

      public void setDefaultRootDeviceType(RootDeviceType defaultRootDeviceType)

      The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.

      Parameters:
      defaultRootDeviceType - The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.
      See Also:
    • withDefaultRootDeviceType

      public Stack withDefaultRootDeviceType(RootDeviceType defaultRootDeviceType)

      The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.

      Parameters:
      defaultRootDeviceType - The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setAgentVersion

      public void setAgentVersion(String agentVersion)

      The agent version. This parameter is set to LATEST for auto-update. or a version number for a fixed agent version.

      Parameters:
      agentVersion - The agent version. This parameter is set to LATEST for auto-update. or a version number for a fixed agent version.
    • getAgentVersion

      public String getAgentVersion()

      The agent version. This parameter is set to LATEST for auto-update. or a version number for a fixed agent version.

      Returns:
      The agent version. This parameter is set to LATEST for auto-update. or a version number for a fixed agent version.
    • withAgentVersion

      public Stack withAgentVersion(String agentVersion)

      The agent version. This parameter is set to LATEST for auto-update. or a version number for a fixed agent version.

      Parameters:
      agentVersion - The agent version. This parameter is set to LATEST for auto-update. or a version number for a fixed agent version.
      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 Stack clone()
      Overrides:
      clone in class Object