Class Stack
- All Implemented Interfaces:
Serializable
,Cloneable
Describes a stack.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAttributesEntry
(String key, String value) Removes all the entries added into Attributes.clone()
boolean
The agent version.getArn()
The stack's ARN.The stack's attributes.AChefConfiguration
object that specifies whether to enable Berkshelf and the Berkshelf version.The configuration manager.The date when the stack was created.A JSON object that contains user-defined attributes to be added to the stack configuration and deployment attributes.The stack's default Availability Zone.The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances.The stack's default operating system.The default root device type.A default Amazon EC2 key pair for the stack's instances.The default subnet ID; applicable only if the stack is running in a VPC.The stack host name theme, with spaces replaced by underscores.getName()
The stack name.The stack AWS region, such as "us-east-1".The stack AWS Identity and Access Management (IAM) role.The stack ID.Whether the stack uses custom cookbooks.Whether the stack automatically associates the AWS OpsWorks built-in security groups with the stack's layers.getVpcId()
The VPC ID; applicable only if the stack is running in a VPC.int
hashCode()
Whether the stack uses custom cookbooks.Whether the stack automatically associates the AWS OpsWorks built-in security groups with the stack's layers.void
setAgentVersion
(String agentVersion) The agent version.void
The stack's ARN.void
setAttributes
(Map<String, String> attributes) The stack's attributes.void
setChefConfiguration
(ChefConfiguration chefConfiguration) AChefConfiguration
object that specifies whether to enable Berkshelf and the Berkshelf version.void
setConfigurationManager
(StackConfigurationManager configurationManager) The configuration manager.void
setCreatedAt
(String createdAt) The date when the stack was created.void
setCustomCookbooksSource
(Source customCookbooksSource) void
setCustomJson
(String customJson) A JSON object that contains user-defined attributes to be added to the stack configuration and deployment attributes.void
setDefaultAvailabilityZone
(String defaultAvailabilityZone) The stack's default Availability Zone.void
setDefaultInstanceProfileArn
(String defaultInstanceProfileArn) The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances.void
setDefaultOs
(String defaultOs) The stack's default operating system.void
setDefaultRootDeviceType
(RootDeviceType defaultRootDeviceType) The default root device type.void
setDefaultRootDeviceType
(String defaultRootDeviceType) The default root device type.void
setDefaultSshKeyName
(String defaultSshKeyName) A default Amazon EC2 key pair for the stack's instances.void
setDefaultSubnetId
(String defaultSubnetId) The default subnet ID; applicable only if the stack is running in a VPC.void
setHostnameTheme
(String hostnameTheme) The stack host name theme, with spaces replaced by underscores.void
The stack name.void
The stack AWS region, such as "us-east-1".void
setServiceRoleArn
(String serviceRoleArn) The stack AWS Identity and Access Management (IAM) role.void
setStackId
(String stackId) The stack ID.void
setUseCustomCookbooks
(Boolean useCustomCookbooks) Whether the stack uses custom cookbooks.void
setUseOpsworksSecurityGroups
(Boolean useOpsworksSecurityGroups) Whether the stack automatically associates the AWS OpsWorks built-in security groups with the stack's layers.void
The VPC ID; applicable only if the stack is running in a VPC.toString()
Returns a string representation of this object; useful for testing and debugging.withAgentVersion
(String agentVersion) The agent version.The stack's ARN.withAttributes
(Map<String, String> attributes) The stack's attributes.withChefConfiguration
(ChefConfiguration chefConfiguration) AChefConfiguration
object that specifies whether to enable Berkshelf and the Berkshelf version.withConfigurationManager
(StackConfigurationManager configurationManager) The configuration manager.withCreatedAt
(String createdAt) The date when the stack was created.withCustomCookbooksSource
(Source customCookbooksSource) withCustomJson
(String customJson) A JSON object that contains user-defined attributes to be added to the stack configuration and deployment attributes.withDefaultAvailabilityZone
(String defaultAvailabilityZone) The stack's default Availability Zone.withDefaultInstanceProfileArn
(String defaultInstanceProfileArn) The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances.withDefaultOs
(String defaultOs) The stack's default operating system.withDefaultRootDeviceType
(RootDeviceType defaultRootDeviceType) The default root device type.withDefaultRootDeviceType
(String defaultRootDeviceType) The default root device type.withDefaultSshKeyName
(String defaultSshKeyName) A default Amazon EC2 key pair for the stack's instances.withDefaultSubnetId
(String defaultSubnetId) The default subnet ID; applicable only if the stack is running in a VPC.withHostnameTheme
(String hostnameTheme) The stack host name theme, with spaces replaced by underscores.The stack name.withRegion
(String region) The stack AWS region, such as "us-east-1".withServiceRoleArn
(String serviceRoleArn) The stack AWS Identity and Access Management (IAM) role.withStackId
(String stackId) The stack ID.withUseCustomCookbooks
(Boolean useCustomCookbooks) Whether the stack uses custom cookbooks.withUseOpsworksSecurityGroups
(Boolean useOpsworksSecurityGroups) Whether the stack automatically associates the AWS OpsWorks built-in security groups with the stack's layers.The VPC ID; applicable only if the stack is running in a VPC.
-
Constructor Details
-
Stack
public Stack()
-
-
Method Details
-
setStackId
The stack ID.
- Parameters:
stackId
- The stack ID.
-
getStackId
The stack ID.
- Returns:
- The stack ID.
-
withStackId
The stack ID.
- Parameters:
stackId
- The stack ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setName
The stack name.
- Parameters:
name
- The stack name.
-
getName
The stack name.
- Returns:
- The stack name.
-
withName
The stack name.
- Parameters:
name
- The stack name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setArn
The stack's ARN.
- Parameters:
arn
- The stack's ARN.
-
getArn
The stack's ARN.
- Returns:
- The stack's ARN.
-
withArn
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
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
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
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
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
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
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
The stack's attributes.
- Returns:
- The stack's attributes.
-
setAttributes
The stack's attributes.
- Parameters:
attributes
- The stack's attributes.
-
withAttributes
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
-
clearAttributesEntries
Removes all the entries added into Attributes. <p> Returns a reference to this object so that method calls can be chained together. -
setServiceRoleArn
The stack AWS Identity and Access Management (IAM) role.
- Parameters:
serviceRoleArn
- The stack AWS Identity and Access Management (IAM) role.
-
getServiceRoleArn
The stack AWS Identity and Access Management (IAM) role.
- Returns:
- The stack AWS Identity and Access Management (IAM) role.
-
withServiceRoleArn
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
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
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
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
The stack's default operating system.
- Parameters:
defaultOs
- The stack's default operating system.
-
getDefaultOs
The stack's default operating system.
- Returns:
- The stack's default operating system.
-
withDefaultOs
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
The stack host name theme, with spaces replaced by underscores.
- Parameters:
hostnameTheme
- The stack host name theme, with spaces replaced by underscores.
-
getHostnameTheme
The stack host name theme, with spaces replaced by underscores.
- Returns:
- The stack host name theme, with spaces replaced by underscores.
-
withHostnameTheme
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
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
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
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
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
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
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
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
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
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
The configuration manager.
- Parameters:
configurationManager
- The configuration manager.
-
getConfigurationManager
The configuration manager.
- Returns:
- The configuration manager.
-
withConfigurationManager
The configuration manager.
- Parameters:
configurationManager
- The configuration manager.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setChefConfiguration
A
ChefConfiguration
object that specifies whether to enable Berkshelf and the Berkshelf version. For more information, see Create a New Stack.- Parameters:
chefConfiguration
- AChefConfiguration
object that specifies whether to enable Berkshelf and the Berkshelf version. For more information, see Create a New Stack.
-
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
A
ChefConfiguration
object that specifies whether to enable Berkshelf and the Berkshelf version. For more information, see Create a New Stack.- Parameters:
chefConfiguration
- AChefConfiguration
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
Whether the stack uses custom cookbooks.
- Parameters:
useCustomCookbooks
- Whether the stack uses custom cookbooks.
-
getUseCustomCookbooks
Whether the stack uses custom cookbooks.
- Returns:
- Whether the stack uses custom cookbooks.
-
withUseCustomCookbooks
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
Whether the stack uses custom cookbooks.
- Returns:
- Whether the stack uses custom cookbooks.
-
setUseOpsworksSecurityGroups
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
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
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
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
- Parameters:
customCookbooksSource
-
-
getCustomCookbooksSource
- Returns:
-
withCustomCookbooksSource
- Parameters:
customCookbooksSource
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDefaultSshKeyName
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
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
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
The date when the stack was created.
- Parameters:
createdAt
- The date when the stack was created.
-
getCreatedAt
The date when the stack was created.
- Returns:
- The date when the stack was created.
-
withCreatedAt
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
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
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
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
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
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
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 toLATEST
for auto-update. or a version number for a fixed agent version.
-
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
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 toLATEST
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-