com.amazonaws.services.opsworks.model

Class UpdateStackRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.opsworks.model.UpdateStackRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateStackRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateStackRequest()

Method Summary

Modifier and Type	Method and Description
UpdateStackRequest	addAttributesEntry(String key, String value)
UpdateStackRequest	clearAttributesEntries() Removes all the entries added into Attributes.
UpdateStackRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAgentVersion() The default AWS OpsWorks Stacks agent version.
Map<String,String>	getAttributes() One or more user-defined key-value pairs to be added to the stack attributes.
ChefConfiguration	getChefConfiguration() A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks.
StackConfigurationManager	getConfigurationManager() The configuration manager.
Source	getCustomCookbooksSource()
String	getCustomJson() A string that contains user-defined, custom JSON.
String	getDefaultAvailabilityZone() The stack's default Availability Zone, which must be in the stack's region.
String	getDefaultInstanceProfileArn() The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances.
String	getDefaultOs() The stack's operating system, which must be set to one of the following:
String	getDefaultRootDeviceType() The default root device type.
String	getDefaultSshKeyName() A default Amazon EC2 key-pair name.
String	getDefaultSubnetId() The stack's default VPC subnet ID.
String	getHostnameTheme() The stack's new host name theme, with spaces replaced by underscores.
String	getName() The stack's new name.
String	getServiceRoleArn() Do not use this parameter.
String	getStackId() The stack ID.
Boolean	getUseCustomCookbooks() Whether the stack uses custom cookbooks.
Boolean	getUseOpsworksSecurityGroups() Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.
int	hashCode()
Boolean	isUseCustomCookbooks() Whether the stack uses custom cookbooks.
Boolean	isUseOpsworksSecurityGroups() Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.
void	setAgentVersion(String agentVersion) The default AWS OpsWorks Stacks agent version.
void	setAttributes(Map<String,String> attributes) One or more user-defined key-value pairs to be added to the stack attributes.
void	setChefConfiguration(ChefConfiguration chefConfiguration) A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks.
void	setConfigurationManager(StackConfigurationManager configurationManager) The configuration manager.
void	setCustomCookbooksSource(Source customCookbooksSource)
void	setCustomJson(String customJson) A string that contains user-defined, custom JSON.
void	setDefaultAvailabilityZone(String defaultAvailabilityZone) The stack's default Availability Zone, which must be in the stack's region.
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 operating system, which must be set to one of the following:
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 name.
void	setDefaultSubnetId(String defaultSubnetId) The stack's default VPC subnet ID.
void	setHostnameTheme(String hostnameTheme) The stack's new host name theme, with spaces replaced by underscores.
void	setName(String name) The stack's new name.
void	setServiceRoleArn(String serviceRoleArn) Do not use this parameter.
void	setStackId(String stackId) The stack ID.
void	setUseCustomCookbooks(Boolean useCustomCookbooks) Whether the stack uses custom cookbooks.
void	setUseOpsworksSecurityGroups(Boolean useOpsworksSecurityGroups) Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UpdateStackRequest	withAgentVersion(String agentVersion) The default AWS OpsWorks Stacks agent version.
UpdateStackRequest	withAttributes(Map<String,String> attributes) One or more user-defined key-value pairs to be added to the stack attributes.
UpdateStackRequest	withChefConfiguration(ChefConfiguration chefConfiguration) A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks.
UpdateStackRequest	withConfigurationManager(StackConfigurationManager configurationManager) The configuration manager.
UpdateStackRequest	withCustomCookbooksSource(Source customCookbooksSource)
UpdateStackRequest	withCustomJson(String customJson) A string that contains user-defined, custom JSON.
UpdateStackRequest	withDefaultAvailabilityZone(String defaultAvailabilityZone) The stack's default Availability Zone, which must be in the stack's region.
UpdateStackRequest	withDefaultInstanceProfileArn(String defaultInstanceProfileArn) The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances.
UpdateStackRequest	withDefaultOs(String defaultOs) The stack's operating system, which must be set to one of the following:
UpdateStackRequest	withDefaultRootDeviceType(RootDeviceType defaultRootDeviceType) The default root device type.
UpdateStackRequest	withDefaultRootDeviceType(String defaultRootDeviceType) The default root device type.
UpdateStackRequest	withDefaultSshKeyName(String defaultSshKeyName) A default Amazon EC2 key-pair name.
UpdateStackRequest	withDefaultSubnetId(String defaultSubnetId) The stack's default VPC subnet ID.
UpdateStackRequest	withHostnameTheme(String hostnameTheme) The stack's new host name theme, with spaces replaced by underscores.
UpdateStackRequest	withName(String name) The stack's new name.
UpdateStackRequest	withServiceRoleArn(String serviceRoleArn) Do not use this parameter.
UpdateStackRequest	withStackId(String stackId) The stack ID.
UpdateStackRequest	withUseCustomCookbooks(Boolean useCustomCookbooks) Whether the stack uses custom cookbooks.
UpdateStackRequest	withUseOpsworksSecurityGroups(Boolean useOpsworksSecurityGroups) Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateStackRequest

public UpdateStackRequest()

Method Detail

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 UpdateStackRequest 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's new name.

Parameters:

name - The stack's new name.

getName

public String getName()

The stack's new name.

Returns:

The stack's new name.

withName

public UpdateStackRequest withName(String name)

The stack's new name.

Parameters:

name - The stack's new name.

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.

Returns:

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

setAttributes

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

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

Parameters:

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

withAttributes

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

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

Parameters:

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

Returns:

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

addAttributesEntry

public UpdateStackRequest addAttributesEntry(String key,
                                             String value)

clearAttributesEntries

public UpdateStackRequest clearAttributesEntries()

Removes all the entries added into Attributes.

Returns:

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

setServiceRoleArn

public void setServiceRoleArn(String serviceRoleArn)

Do not use this parameter. You cannot update a stack's service role.

Parameters:

serviceRoleArn - Do not use this parameter. You cannot update a stack's service role.

getServiceRoleArn

public String getServiceRoleArn()

Do not use this parameter. You cannot update a stack's service role.

Returns:

Do not use this parameter. You cannot update a stack's service role.

withServiceRoleArn

public UpdateStackRequest withServiceRoleArn(String serviceRoleArn)

Do not use this parameter. You cannot update a stack's service role.

Parameters:

serviceRoleArn - Do not use this parameter. You cannot update a stack's service 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 UpdateStackRequest 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 operating system, which must be set to one of the following:

• A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

• A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

• CentOS Linux 7

• Red Hat Enterprise Linux 7

• A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

• A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more information on how to use custom AMIs with OpsWorks, see Using Custom AMIs.

The default option is the stack's current operating system. For more information on the supported operating systems, see AWS OpsWorks Stacks Operating Systems.

Parameters:

defaultOs - The stack's operating system, which must be set to one of the following:

• A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

• A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

• CentOS Linux 7

• Red Hat Enterprise Linux 7

• A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

• A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more information on how to use custom AMIs with OpsWorks, see Using Custom AMIs.

The default option is the stack's current operating system. For more information on the supported operating systems, see AWS OpsWorks Stacks Operating Systems.

getDefaultOs

public String getDefaultOs()

The stack's operating system, which must be set to one of the following:

• A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

• A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

• CentOS Linux 7

• Red Hat Enterprise Linux 7

• A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

• A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more information on how to use custom AMIs with OpsWorks, see Using Custom AMIs.

The default option is the stack's current operating system. For more information on the supported operating systems, see AWS OpsWorks Stacks Operating Systems.

Returns:

The stack's operating system, which must be set to one of the following:

• A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

• A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS , or Ubuntu 12.04 LTS.

• CentOS Linux 7

• Red Hat Enterprise Linux 7

• A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

• A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more information on how to use custom AMIs with OpsWorks, see Using Custom AMIs.

The default option is the stack's current operating system. For more information on the supported operating systems, see AWS OpsWorks Stacks Operating Systems.

withDefaultOs

public UpdateStackRequest withDefaultOs(String defaultOs)

The stack's operating system, which must be set to one of the following:

• A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

• A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

• CentOS Linux 7

• Red Hat Enterprise Linux 7

• A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

• A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more information on how to use custom AMIs with OpsWorks, see Using Custom AMIs.

The default option is the stack's current operating system. For more information on the supported operating systems, see AWS OpsWorks Stacks Operating Systems.

Parameters:

defaultOs - The stack's operating system, which must be set to one of the following:

• A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

• A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

• CentOS Linux 7

• Red Hat Enterprise Linux 7

• A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

• A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more information on how to use custom AMIs with OpsWorks, see Using Custom AMIs.

The default option is the stack's current operating system. For more information on the supported operating systems, see AWS OpsWorks Stacks Operating Systems.

Returns:

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

setHostnameTheme

public void setHostnameTheme(String hostnameTheme)

The stack's new host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:

• Baked_Goods

• Clouds

• Europe_Cities

• Fruits

• Greek_Deities

• Legendary_creatures_from_Japan

• Planets_and_Moons

• Roman_Deities

• Scottish_Islands

• US_Cities

• Wild_Cats

To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.

Parameters:

hostnameTheme - The stack's new host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:

• Baked_Goods

• Clouds

• Europe_Cities

• Fruits

• Greek_Deities

• Legendary_creatures_from_Japan

• Planets_and_Moons

• Roman_Deities

• Scottish_Islands

• US_Cities

• Wild_Cats

To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.

getHostnameTheme

public String getHostnameTheme()

The stack's new host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:

• Baked_Goods

• Clouds

• Europe_Cities

• Fruits

• Greek_Deities

• Legendary_creatures_from_Japan

• Planets_and_Moons

• Roman_Deities

• Scottish_Islands

• US_Cities

• Wild_Cats

To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.

Returns:

The stack's new host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:

• Baked_Goods

• Clouds

• Europe_Cities

• Fruits

• Greek_Deities

• Legendary_creatures_from_Japan

• Planets_and_Moons

• Roman_Deities

• Scottish_Islands

• US_Cities

• Wild_Cats

To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.

withHostnameTheme

public UpdateStackRequest withHostnameTheme(String hostnameTheme)

The stack's new host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:

• Baked_Goods

• Clouds

• Europe_Cities

• Fruits

• Greek_Deities

• Legendary_creatures_from_Japan

• Planets_and_Moons

• Roman_Deities

• Scottish_Islands

• US_Cities

• Wild_Cats

To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.

Parameters:

hostnameTheme - The stack's new host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:

• Baked_Goods

• Clouds

• Europe_Cities

• Fruits

• Greek_Deities

• Legendary_creatures_from_Japan

• Planets_and_Moons

• Roman_Deities

• Scottish_Islands

• US_Cities

• Wild_Cats

To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.

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, which must be in the stack's region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see CreateStack.

Parameters:

defaultAvailabilityZone - The stack's default Availability Zone, which must be in the stack's region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see CreateStack.

getDefaultAvailabilityZone

public String getDefaultAvailabilityZone()

The stack's default Availability Zone, which must be in the stack's region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see CreateStack.

Returns:

The stack's default Availability Zone, which must be in the stack's region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see CreateStack.

withDefaultAvailabilityZone

public UpdateStackRequest withDefaultAvailabilityZone(String defaultAvailabilityZone)

The stack's default Availability Zone, which must be in the stack's region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see CreateStack.

Parameters:

defaultAvailabilityZone - The stack's default Availability Zone, which must be in the stack's region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see CreateStack.

Returns:

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

setDefaultSubnetId

public void setDefaultSubnetId(String defaultSubnetId)

The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.

Parameters:

defaultSubnetId - The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.

getDefaultSubnetId

public String getDefaultSubnetId()

The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.

Returns:

The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.

withDefaultSubnetId

public UpdateStackRequest withDefaultSubnetId(String defaultSubnetId)

The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.

Parameters:

defaultSubnetId - The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.

Returns:

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

setCustomJson

public void setCustomJson(String customJson)

A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration JSON values or to pass data to recipes. The string should be in the following format:

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

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

Parameters:

customJson - A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration JSON values or to pass data to recipes. The string should be in the following format:

"{\"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 string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration JSON values or to pass data to recipes. The string should be in the following format:

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

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

Returns:

A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration JSON values or to pass data to recipes. The string should be in the following format:

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

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

withCustomJson

public UpdateStackRequest withCustomJson(String customJson)

A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration JSON values or to pass data to recipes. The string should be in the following format:

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

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

Parameters:

customJson - A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration JSON values or to pass data to recipes. The string should be in the following format:

"{\"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. When you update a stack, we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 11.4.

Parameters:

configurationManager - The configuration manager. When you update a stack, we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 11.4.

getConfigurationManager

public StackConfigurationManager getConfigurationManager()

The configuration manager. When you update a stack, we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 11.4.

Returns:

The configuration manager. When you update a stack, we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 11.4.

withConfigurationManager

public UpdateStackRequest withConfigurationManager(StackConfigurationManager configurationManager)

The configuration manager. When you update a stack, we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 11.4.

Parameters:

configurationManager - The configuration manager. When you update a stack, we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 11.4.

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 on Chef 11.10 stacks. For more information, see Create a New Stack.

Parameters:

chefConfiguration - A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. 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 on Chef 11.10 stacks. For more information, see Create a New Stack.

Returns:

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

withChefConfiguration

public UpdateStackRequest withChefConfiguration(ChefConfiguration chefConfiguration)

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

Parameters:

chefConfiguration - A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. 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 UpdateStackRequest 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.

setCustomCookbooksSource

public void setCustomCookbooksSource(Source customCookbooksSource)

Parameters:

customCookbooksSource -

getCustomCookbooksSource

public Source getCustomCookbooksSource()

Returns:

withCustomCookbooksSource

public UpdateStackRequest 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 name. The default value is none. If you specify a key-pair name, AWS OpsWorks Stacks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance.

Parameters:

defaultSshKeyName - A default Amazon EC2 key-pair name. The default value is none. If you specify a key-pair name, AWS OpsWorks Stacks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance.

getDefaultSshKeyName

public String getDefaultSshKeyName()

A default Amazon EC2 key-pair name. The default value is none. If you specify a key-pair name, AWS OpsWorks Stacks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance.

Returns:

A default Amazon EC2 key-pair name. The default value is none. If you specify a key-pair name, AWS OpsWorks Stacks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance.

withDefaultSshKeyName

public UpdateStackRequest withDefaultSshKeyName(String defaultSshKeyName)

A default Amazon EC2 key-pair name. The default value is none. If you specify a key-pair name, AWS OpsWorks Stacks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance.

Parameters:

defaultSshKeyName - A default Amazon EC2 key-pair name. The default value is none. If you specify a key-pair name, AWS OpsWorks Stacks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance.

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:

RootDeviceType

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:

RootDeviceType

withDefaultRootDeviceType

public UpdateStackRequest 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:

RootDeviceType

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:

RootDeviceType

withDefaultRootDeviceType

public UpdateStackRequest 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:

RootDeviceType

setUseOpsworksSecurityGroups

public void setUseOpsworksSecurityGroups(Boolean useOpsworksSecurityGroups)

Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.

AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. UseOpsworksSecurityGroups allows you to provide your own custom security groups instead of using the built-in groups. UseOpsworksSecurityGroups has the following settings:

• True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.

• False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on. Custom security groups are required only for those layers that need custom settings.

For more information, see Create a New Stack.

Parameters:

useOpsworksSecurityGroups - Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.

AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. UseOpsworksSecurityGroups allows you to provide your own custom security groups instead of using the built-in groups. UseOpsworksSecurityGroups has the following settings:

• True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.

• False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on. Custom security groups are required only for those layers that need custom settings.

For more information, see Create a New Stack.

getUseOpsworksSecurityGroups

public Boolean getUseOpsworksSecurityGroups()

Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.

AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. UseOpsworksSecurityGroups allows you to provide your own custom security groups instead of using the built-in groups. UseOpsworksSecurityGroups has the following settings:

• True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.

• False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on. Custom security groups are required only for those layers that need custom settings.

For more information, see Create a New Stack.

Returns:

Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.

AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. UseOpsworksSecurityGroups allows you to provide your own custom security groups instead of using the built-in groups. UseOpsworksSecurityGroups has the following settings:

• True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.

• False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on. Custom security groups are required only for those layers that need custom settings.

For more information, see Create a New Stack.

withUseOpsworksSecurityGroups

public UpdateStackRequest withUseOpsworksSecurityGroups(Boolean useOpsworksSecurityGroups)

Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.

AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. UseOpsworksSecurityGroups allows you to provide your own custom security groups instead of using the built-in groups. UseOpsworksSecurityGroups has the following settings:

• True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.

• False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on. Custom security groups are required only for those layers that need custom settings.

For more information, see Create a New Stack.

Parameters:

useOpsworksSecurityGroups - Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.

AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. UseOpsworksSecurityGroups allows you to provide your own custom security groups instead of using the built-in groups. UseOpsworksSecurityGroups has the following settings:

• True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.

• False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on. Custom security groups are required only for those layers that need custom settings.

For more information, see Create a New Stack.

Returns:

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

isUseOpsworksSecurityGroups

public Boolean isUseOpsworksSecurityGroups()

Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.

AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. UseOpsworksSecurityGroups allows you to provide your own custom security groups instead of using the built-in groups. UseOpsworksSecurityGroups has the following settings:

• True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.

• False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on. Custom security groups are required only for those layers that need custom settings.

For more information, see Create a New Stack.

Returns:

Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.

AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. UseOpsworksSecurityGroups allows you to provide your own custom security groups instead of using the built-in groups. UseOpsworksSecurityGroups has the following settings:

• True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.

• False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on. Custom security groups are required only for those layers that need custom settings.

For more information, see Create a New Stack.

setAgentVersion

public void setAgentVersion(String agentVersion)

The default AWS OpsWorks Stacks agent version. You have the following options:

• Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available.

• Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances.

The default setting is LATEST. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.

Parameters:

agentVersion - The default AWS OpsWorks Stacks agent version. You have the following options:

• Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available.

• Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances.

The default setting is LATEST. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.

getAgentVersion

public String getAgentVersion()

The default AWS OpsWorks Stacks agent version. You have the following options:

• Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available.

• Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances.

The default setting is LATEST. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.

Returns:

The default AWS OpsWorks Stacks agent version. You have the following options:

• Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available.

• Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances.

The default setting is LATEST. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.

withAgentVersion

public UpdateStackRequest withAgentVersion(String agentVersion)

The default AWS OpsWorks Stacks agent version. You have the following options:

• Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available.

• Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances.

The default setting is LATEST. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.

Parameters:

agentVersion - The default AWS OpsWorks Stacks agent version. You have the following options:

• Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available.

• Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances.

The default setting is LATEST. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.

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:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateStackRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()