com.amazonaws.services.opsworks.model
Class Stack

java.lang.Object
  com.amazonaws.services.opsworks.model.Stack

All Implemented Interfaces:

java.io.Serializable

public class Stack
extends java.lang.Object
implements java.io.Serializable

Describes a stack.

See Also:

Serialized Form

Constructor Summary

Stack()

Method Summary

Stack	addAttributesEntry(java.lang.String key, java.lang.String value) The contents of the stack's attributes bag.
Stack	clearAttributesEntries() Removes all the entries added into Attributes.
boolean	equals(java.lang.Object obj)
java.util.Map<java.lang.String,java.lang.String>	getAttributes() The contents of the stack's attributes bag.
java.lang.String	getCreatedAt() Date when the stack was created.
Source	getCustomCookbooksSource() Contains the information required to retrieve an app or cookbook from a repository.
java.lang.String	getCustomJson() A string that contains user-defined, custom JSON.
java.lang.String	getDefaultAvailabilityZone() The stack's default Availability Zone.
java.lang.String	getDefaultInstanceProfileArn() The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances.
java.lang.String	getDefaultOs() The cloned stack default operating system, which must be either "Amazon Linux" or "Ubuntu 12.04 LTS".
java.lang.String	getDefaultRootDeviceType() The default root device type.
java.lang.String	getDefaultSshKeyName() A default SSH key for the stack's instances.
java.lang.String	getHostnameTheme() The stack host name theme, with spaces replaced by underscores.
java.lang.String	getName() The stack name.
java.lang.String	getRegion() The stack AWS region, such as "us-east-1".
java.lang.String	getServiceRoleArn() The stack AWS Identity and Access Management (IAM) role.
java.lang.String	getStackId() The stack ID.
java.lang.Boolean	getUseCustomCookbooks() Whether the stack uses custom cookbooks.
int	hashCode()
java.lang.Boolean	isUseCustomCookbooks() Whether the stack uses custom cookbooks.
void	setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes) The contents of the stack's attributes bag.
void	setCreatedAt(java.lang.String createdAt) Date when the stack was created.
void	setCustomCookbooksSource(Source customCookbooksSource) Contains the information required to retrieve an app or cookbook from a repository.
void	setCustomJson(java.lang.String customJson) A string that contains user-defined, custom JSON.
void	setDefaultAvailabilityZone(java.lang.String defaultAvailabilityZone) The stack's default Availability Zone.
void	setDefaultInstanceProfileArn(java.lang.String defaultInstanceProfileArn) The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances.
void	setDefaultOs(java.lang.String defaultOs) The cloned stack default operating system, which must be either "Amazon Linux" or "Ubuntu 12.04 LTS".
void	setDefaultRootDeviceType(RootDeviceType defaultRootDeviceType) The default root device type.
void	setDefaultRootDeviceType(java.lang.String defaultRootDeviceType) The default root device type.
void	setDefaultSshKeyName(java.lang.String defaultSshKeyName) A default SSH key for the stack's instances.
void	setHostnameTheme(java.lang.String hostnameTheme) The stack host name theme, with spaces replaced by underscores.
void	setName(java.lang.String name) The stack name.
void	setRegion(java.lang.String region) The stack AWS region, such as "us-east-1".
void	setServiceRoleArn(java.lang.String serviceRoleArn) The stack AWS Identity and Access Management (IAM) role.
void	setStackId(java.lang.String stackId) The stack ID.
void	setUseCustomCookbooks(java.lang.Boolean useCustomCookbooks) Whether the stack uses custom cookbooks.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
Stack	withAttributes(java.util.Map<java.lang.String,java.lang.String> attributes) The contents of the stack's attributes bag.
Stack	withCreatedAt(java.lang.String createdAt) Date when the stack was created.
Stack	withCustomCookbooksSource(Source customCookbooksSource) Contains the information required to retrieve an app or cookbook from a repository.
Stack	withCustomJson(java.lang.String customJson) A string that contains user-defined, custom JSON.
Stack	withDefaultAvailabilityZone(java.lang.String defaultAvailabilityZone) The stack's default Availability Zone.
Stack	withDefaultInstanceProfileArn(java.lang.String defaultInstanceProfileArn) The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances.
Stack	withDefaultOs(java.lang.String defaultOs) The cloned stack default operating system, which must be either "Amazon Linux" or "Ubuntu 12.04 LTS".
Stack	withDefaultRootDeviceType(RootDeviceType defaultRootDeviceType) The default root device type.
Stack	withDefaultRootDeviceType(java.lang.String defaultRootDeviceType) The default root device type.
Stack	withDefaultSshKeyName(java.lang.String defaultSshKeyName) A default SSH key for the stack's instances.
Stack	withHostnameTheme(java.lang.String hostnameTheme) The stack host name theme, with spaces replaced by underscores.
Stack	withName(java.lang.String name) The stack name.
Stack	withRegion(java.lang.String region) The stack AWS region, such as "us-east-1".
Stack	withServiceRoleArn(java.lang.String serviceRoleArn) The stack AWS Identity and Access Management (IAM) role.
Stack	withStackId(java.lang.String stackId) The stack ID.
Stack	withUseCustomCookbooks(java.lang.Boolean useCustomCookbooks) Whether the stack uses custom cookbooks.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Stack

public Stack()

Method Detail

getStackId

public java.lang.String getStackId()

The stack ID.

Returns:

The stack ID.

setStackId

public void setStackId(java.lang.String stackId)

The stack ID.

Parameters:

stackId - The stack ID.

withStackId

public Stack withStackId(java.lang.String stackId)

The stack ID.

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

Parameters:

stackId - The stack ID.

getName

public java.lang.String getName()

The stack name.

Returns:

The stack name.

setName

public void setName(java.lang.String name)

The stack name.

Parameters:

name - The stack name.

withName

public Stack withName(java.lang.String name)

The stack name.

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

Parameters:

name - The stack name.

getRegion

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

setRegion

public void setRegion(java.lang.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.

withRegion

public Stack withRegion(java.lang.String region)

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

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

Parameters:

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

getAttributes

public java.util.Map<java.lang.String,java.lang.String> getAttributes()

The contents of the stack's attributes bag.

Returns:

The contents of the stack's attributes bag.

setAttributes

public void setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)

The contents of the stack's attributes bag.

Parameters:

attributes - The contents of the stack's attributes bag.

withAttributes

public Stack withAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)

The contents of the stack's attributes bag.

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

Parameters:

attributes - The contents of the stack's attributes bag.

addAttributesEntry

public Stack addAttributesEntry(java.lang.String key,
                                java.lang.String value)

The contents of the stack's attributes bag.

The method adds a new key-value pair into Attributes parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into Attributes.

value - The corresponding value of the entry to be added into Attributes.

clearAttributesEntries

public Stack clearAttributesEntries()

Removes all the entries added into Attributes.

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

getServiceRoleArn

public java.lang.String getServiceRoleArn()

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

Returns:

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

setServiceRoleArn

public void setServiceRoleArn(java.lang.String serviceRoleArn)

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

Parameters:

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

withServiceRoleArn

public Stack withServiceRoleArn(java.lang.String serviceRoleArn)

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

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

Parameters:

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

getDefaultInstanceProfileArn

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

setDefaultInstanceProfileArn

public void setDefaultInstanceProfileArn(java.lang.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.

withDefaultInstanceProfileArn

public Stack withDefaultInstanceProfileArn(java.lang.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.

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

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.

getDefaultOs

public java.lang.String getDefaultOs()

The cloned stack default operating system, which must be either "Amazon Linux" or "Ubuntu 12.04 LTS".

Returns:

The cloned stack default operating system, which must be either "Amazon Linux" or "Ubuntu 12.04 LTS".

setDefaultOs

public void setDefaultOs(java.lang.String defaultOs)

The cloned stack default operating system, which must be either "Amazon Linux" or "Ubuntu 12.04 LTS".

Parameters:

defaultOs - The cloned stack default operating system, which must be either "Amazon Linux" or "Ubuntu 12.04 LTS".

withDefaultOs

public Stack withDefaultOs(java.lang.String defaultOs)

The cloned stack default operating system, which must be either "Amazon Linux" or "Ubuntu 12.04 LTS".

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

Parameters:

defaultOs - The cloned stack default operating system, which must be either "Amazon Linux" or "Ubuntu 12.04 LTS".

getHostnameTheme

public java.lang.String getHostnameTheme()

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

Returns:

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

setHostnameTheme

public void setHostnameTheme(java.lang.String hostnameTheme)

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

Parameters:

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

withHostnameTheme

public Stack withHostnameTheme(java.lang.String hostnameTheme)

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

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

Parameters:

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

getDefaultAvailabilityZone

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

setDefaultAvailabilityZone

public void setDefaultAvailabilityZone(java.lang.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.

withDefaultAvailabilityZone

public Stack withDefaultAvailabilityZone(java.lang.String defaultAvailabilityZone)

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

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

Parameters:

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

getCustomJson

public java.lang.String getCustomJson()

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. 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 JSON.

Returns:

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. 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 JSON.

setCustomJson

public void setCustomJson(java.lang.String customJson)

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. 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 JSON.

Parameters:

customJson - A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. 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 JSON.

withCustomJson

public Stack withCustomJson(java.lang.String customJson)

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. 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 JSON.

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

Parameters:

customJson - A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. 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 JSON.

isUseCustomCookbooks

public java.lang.Boolean isUseCustomCookbooks()

Whether the stack uses custom cookbooks.

Returns:

Whether the stack uses custom cookbooks.

setUseCustomCookbooks

public void setUseCustomCookbooks(java.lang.Boolean useCustomCookbooks)

Whether the stack uses custom cookbooks.

Parameters:

useCustomCookbooks - Whether the stack uses custom cookbooks.

withUseCustomCookbooks

public Stack withUseCustomCookbooks(java.lang.Boolean useCustomCookbooks)

Whether the stack uses custom cookbooks.

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

Parameters:

useCustomCookbooks - Whether the stack uses custom cookbooks.

getUseCustomCookbooks

public java.lang.Boolean getUseCustomCookbooks()

Whether the stack uses custom cookbooks.

Returns:

Whether the stack uses custom cookbooks.

getCustomCookbooksSource

public Source getCustomCookbooksSource()

Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Apps or Custom Recipes and Cookbooks.

Returns:

Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Apps or Custom Recipes and Cookbooks.

setCustomCookbooksSource

public void setCustomCookbooksSource(Source customCookbooksSource)

Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Apps or Custom Recipes and Cookbooks.

Parameters:

customCookbooksSource - Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Apps or Custom Recipes and Cookbooks.

withCustomCookbooksSource

public Stack withCustomCookbooksSource(Source customCookbooksSource)

Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Apps or Custom Recipes and Cookbooks.

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

Parameters:

customCookbooksSource - Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Apps or Custom Recipes and Cookbooks.

getDefaultSshKeyName

public java.lang.String getDefaultSshKeyName()

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

Returns:

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

setDefaultSshKeyName

public void setDefaultSshKeyName(java.lang.String defaultSshKeyName)

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

Parameters:

defaultSshKeyName - A default SSH key for the stack's instances. You can override this value when you create or update an instance.

withDefaultSshKeyName

public Stack withDefaultSshKeyName(java.lang.String defaultSshKeyName)

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

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

Parameters:

defaultSshKeyName - A default SSH key for the stack's instances. You can override this value when you create or update an instance.

getCreatedAt

public java.lang.String getCreatedAt()

Date when the stack was created.

Returns:

Date when the stack was created.

setCreatedAt

public void setCreatedAt(java.lang.String createdAt)

Date when the stack was created.

Parameters:

createdAt - Date when the stack was created.

withCreatedAt

public Stack withCreatedAt(java.lang.String createdAt)

Date when the stack was created.

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

Parameters:

createdAt - Date when the stack was created.

getDefaultRootDeviceType

public java.lang.String getDefaultRootDeviceType()

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

Constraints:
Allowed Values: ebs, instance-store

Returns:

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

See Also:

RootDeviceType

setDefaultRootDeviceType

public void setDefaultRootDeviceType(java.lang.String defaultRootDeviceType)

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

Constraints:
Allowed Values: ebs, instance-store

Parameters:

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

See Also:

RootDeviceType

withDefaultRootDeviceType

public Stack withDefaultRootDeviceType(java.lang.String defaultRootDeviceType)

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

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

Constraints:
Allowed Values: ebs, instance-store

Parameters:

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

See Also:

RootDeviceType

setDefaultRootDeviceType

public void setDefaultRootDeviceType(RootDeviceType defaultRootDeviceType)

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

Constraints:
Allowed Values: ebs, instance-store

Parameters:

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

See Also:

RootDeviceType

withDefaultRootDeviceType

public Stack withDefaultRootDeviceType(RootDeviceType defaultRootDeviceType)

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

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

Constraints:
Allowed Values: ebs, instance-store

Parameters:

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

See Also:

RootDeviceType

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object