AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::OpsWorks::Model::UpdateStackRequest Class Reference

#include <UpdateStackRequest.h>

+ Inheritance diagram for Aws::OpsWorks::Model::UpdateStackRequest:

Public Member Functions

 UpdateStackRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetStackId () const
 
bool StackIdHasBeenSet () const
 
void SetStackId (const Aws::String &value)
 
void SetStackId (Aws::String &&value)
 
void SetStackId (const char *value)
 
UpdateStackRequestWithStackId (const Aws::String &value)
 
UpdateStackRequestWithStackId (Aws::String &&value)
 
UpdateStackRequestWithStackId (const char *value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
UpdateStackRequestWithName (const Aws::String &value)
 
UpdateStackRequestWithName (Aws::String &&value)
 
UpdateStackRequestWithName (const char *value)
 
const Aws::Map< StackAttributesKeys, Aws::String > & GetAttributes () const
 
bool AttributesHasBeenSet () const
 
void SetAttributes (const Aws::Map< StackAttributesKeys, Aws::String > &value)
 
void SetAttributes (Aws::Map< StackAttributesKeys, Aws::String > &&value)
 
UpdateStackRequestWithAttributes (const Aws::Map< StackAttributesKeys, Aws::String > &value)
 
UpdateStackRequestWithAttributes (Aws::Map< StackAttributesKeys, Aws::String > &&value)
 
UpdateStackRequestAddAttributes (const StackAttributesKeys &key, const Aws::String &value)
 
UpdateStackRequestAddAttributes (StackAttributesKeys &&key, const Aws::String &value)
 
UpdateStackRequestAddAttributes (const StackAttributesKeys &key, Aws::String &&value)
 
UpdateStackRequestAddAttributes (StackAttributesKeys &&key, Aws::String &&value)
 
UpdateStackRequestAddAttributes (StackAttributesKeys &&key, const char *value)
 
UpdateStackRequestAddAttributes (const StackAttributesKeys &key, const char *value)
 
const Aws::StringGetServiceRoleArn () const
 
bool ServiceRoleArnHasBeenSet () const
 
void SetServiceRoleArn (const Aws::String &value)
 
void SetServiceRoleArn (Aws::String &&value)
 
void SetServiceRoleArn (const char *value)
 
UpdateStackRequestWithServiceRoleArn (const Aws::String &value)
 
UpdateStackRequestWithServiceRoleArn (Aws::String &&value)
 
UpdateStackRequestWithServiceRoleArn (const char *value)
 
const Aws::StringGetDefaultInstanceProfileArn () const
 
bool DefaultInstanceProfileArnHasBeenSet () const
 
void SetDefaultInstanceProfileArn (const Aws::String &value)
 
void SetDefaultInstanceProfileArn (Aws::String &&value)
 
void SetDefaultInstanceProfileArn (const char *value)
 
UpdateStackRequestWithDefaultInstanceProfileArn (const Aws::String &value)
 
UpdateStackRequestWithDefaultInstanceProfileArn (Aws::String &&value)
 
UpdateStackRequestWithDefaultInstanceProfileArn (const char *value)
 
const Aws::StringGetDefaultOs () const
 
bool DefaultOsHasBeenSet () const
 
void SetDefaultOs (const Aws::String &value)
 
void SetDefaultOs (Aws::String &&value)
 
void SetDefaultOs (const char *value)
 
UpdateStackRequestWithDefaultOs (const Aws::String &value)
 
UpdateStackRequestWithDefaultOs (Aws::String &&value)
 
UpdateStackRequestWithDefaultOs (const char *value)
 
const Aws::StringGetHostnameTheme () const
 
bool HostnameThemeHasBeenSet () const
 
void SetHostnameTheme (const Aws::String &value)
 
void SetHostnameTheme (Aws::String &&value)
 
void SetHostnameTheme (const char *value)
 
UpdateStackRequestWithHostnameTheme (const Aws::String &value)
 
UpdateStackRequestWithHostnameTheme (Aws::String &&value)
 
UpdateStackRequestWithHostnameTheme (const char *value)
 
const Aws::StringGetDefaultAvailabilityZone () const
 
bool DefaultAvailabilityZoneHasBeenSet () const
 
void SetDefaultAvailabilityZone (const Aws::String &value)
 
void SetDefaultAvailabilityZone (Aws::String &&value)
 
void SetDefaultAvailabilityZone (const char *value)
 
UpdateStackRequestWithDefaultAvailabilityZone (const Aws::String &value)
 
UpdateStackRequestWithDefaultAvailabilityZone (Aws::String &&value)
 
UpdateStackRequestWithDefaultAvailabilityZone (const char *value)
 
const Aws::StringGetDefaultSubnetId () const
 
bool DefaultSubnetIdHasBeenSet () const
 
void SetDefaultSubnetId (const Aws::String &value)
 
void SetDefaultSubnetId (Aws::String &&value)
 
void SetDefaultSubnetId (const char *value)
 
UpdateStackRequestWithDefaultSubnetId (const Aws::String &value)
 
UpdateStackRequestWithDefaultSubnetId (Aws::String &&value)
 
UpdateStackRequestWithDefaultSubnetId (const char *value)
 
const Aws::StringGetCustomJson () const
 
bool CustomJsonHasBeenSet () const
 
void SetCustomJson (const Aws::String &value)
 
void SetCustomJson (Aws::String &&value)
 
void SetCustomJson (const char *value)
 
UpdateStackRequestWithCustomJson (const Aws::String &value)
 
UpdateStackRequestWithCustomJson (Aws::String &&value)
 
UpdateStackRequestWithCustomJson (const char *value)
 
const StackConfigurationManagerGetConfigurationManager () const
 
bool ConfigurationManagerHasBeenSet () const
 
void SetConfigurationManager (const StackConfigurationManager &value)
 
void SetConfigurationManager (StackConfigurationManager &&value)
 
UpdateStackRequestWithConfigurationManager (const StackConfigurationManager &value)
 
UpdateStackRequestWithConfigurationManager (StackConfigurationManager &&value)
 
const ChefConfigurationGetChefConfiguration () const
 
bool ChefConfigurationHasBeenSet () const
 
void SetChefConfiguration (const ChefConfiguration &value)
 
void SetChefConfiguration (ChefConfiguration &&value)
 
UpdateStackRequestWithChefConfiguration (const ChefConfiguration &value)
 
UpdateStackRequestWithChefConfiguration (ChefConfiguration &&value)
 
bool GetUseCustomCookbooks () const
 
bool UseCustomCookbooksHasBeenSet () const
 
void SetUseCustomCookbooks (bool value)
 
UpdateStackRequestWithUseCustomCookbooks (bool value)
 
const SourceGetCustomCookbooksSource () const
 
bool CustomCookbooksSourceHasBeenSet () const
 
void SetCustomCookbooksSource (const Source &value)
 
void SetCustomCookbooksSource (Source &&value)
 
UpdateStackRequestWithCustomCookbooksSource (const Source &value)
 
UpdateStackRequestWithCustomCookbooksSource (Source &&value)
 
const Aws::StringGetDefaultSshKeyName () const
 
bool DefaultSshKeyNameHasBeenSet () const
 
void SetDefaultSshKeyName (const Aws::String &value)
 
void SetDefaultSshKeyName (Aws::String &&value)
 
void SetDefaultSshKeyName (const char *value)
 
UpdateStackRequestWithDefaultSshKeyName (const Aws::String &value)
 
UpdateStackRequestWithDefaultSshKeyName (Aws::String &&value)
 
UpdateStackRequestWithDefaultSshKeyName (const char *value)
 
const RootDeviceTypeGetDefaultRootDeviceType () const
 
bool DefaultRootDeviceTypeHasBeenSet () const
 
void SetDefaultRootDeviceType (const RootDeviceType &value)
 
void SetDefaultRootDeviceType (RootDeviceType &&value)
 
UpdateStackRequestWithDefaultRootDeviceType (const RootDeviceType &value)
 
UpdateStackRequestWithDefaultRootDeviceType (RootDeviceType &&value)
 
bool GetUseOpsworksSecurityGroups () const
 
bool UseOpsworksSecurityGroupsHasBeenSet () const
 
void SetUseOpsworksSecurityGroups (bool value)
 
UpdateStackRequestWithUseOpsworksSecurityGroups (bool value)
 
const Aws::StringGetAgentVersion () const
 
bool AgentVersionHasBeenSet () const
 
void SetAgentVersion (const Aws::String &value)
 
void SetAgentVersion (Aws::String &&value)
 
void SetAgentVersion (const char *value)
 
UpdateStackRequestWithAgentVersion (const Aws::String &value)
 
UpdateStackRequestWithAgentVersion (Aws::String &&value)
 
UpdateStackRequestWithAgentVersion (const char *value)
 
- Public Member Functions inherited from Aws::OpsWorks::OpsWorksRequest
virtual ~OpsWorksRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 27 of file UpdateStackRequest.h.

Constructor & Destructor Documentation

◆ UpdateStackRequest()

Aws::OpsWorks::Model::UpdateStackRequest::UpdateStackRequest ( )

Member Function Documentation

◆ AddAttributes() [1/6]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::AddAttributes ( const StackAttributesKeys key,
const Aws::String value 
)
inline

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

Definition at line 165 of file UpdateStackRequest.h.

◆ AddAttributes() [2/6]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::AddAttributes ( StackAttributesKeys &&  key,
const Aws::String value 
)
inline

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

Definition at line 171 of file UpdateStackRequest.h.

◆ AddAttributes() [3/6]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::AddAttributes ( const StackAttributesKeys key,
Aws::String &&  value 
)
inline

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

Definition at line 177 of file UpdateStackRequest.h.

◆ AddAttributes() [4/6]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::AddAttributes ( StackAttributesKeys &&  key,
Aws::String &&  value 
)
inline

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

Definition at line 183 of file UpdateStackRequest.h.

◆ AddAttributes() [5/6]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::AddAttributes ( StackAttributesKeys &&  key,
const char *  value 
)
inline

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

Definition at line 189 of file UpdateStackRequest.h.

◆ AddAttributes() [6/6]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::AddAttributes ( const StackAttributesKeys key,
const char *  value 
)
inline

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

Definition at line 195 of file UpdateStackRequest.h.

◆ AgentVersionHasBeenSet()

bool Aws::OpsWorks::Model::UpdateStackRequest::AgentVersionHasBeenSet ( ) const
inline

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.

Definition at line 1390 of file UpdateStackRequest.h.

◆ AttributesHasBeenSet()

bool Aws::OpsWorks::Model::UpdateStackRequest::AttributesHasBeenSet ( ) const
inline

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

Definition at line 135 of file UpdateStackRequest.h.

◆ ChefConfigurationHasBeenSet()

bool Aws::OpsWorks::Model::UpdateStackRequest::ChefConfigurationHasBeenSet ( ) const
inline

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.

Definition at line 974 of file UpdateStackRequest.h.

◆ ConfigurationManagerHasBeenSet()

bool Aws::OpsWorks::Model::UpdateStackRequest::ConfigurationManagerHasBeenSet ( ) const
inline

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

Definition at line 923 of file UpdateStackRequest.h.

◆ CustomCookbooksSourceHasBeenSet()

bool Aws::OpsWorks::Model::UpdateStackRequest::CustomCookbooksSourceHasBeenSet ( ) const
inline

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

Definition at line 1052 of file UpdateStackRequest.h.

◆ CustomJsonHasBeenSet()

bool Aws::OpsWorks::Model::UpdateStackRequest::CustomJsonHasBeenSet ( ) const
inline

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 about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

Definition at line 840 of file UpdateStackRequest.h.

◆ DefaultAvailabilityZoneHasBeenSet()

bool Aws::OpsWorks::Model::UpdateStackRequest::DefaultAvailabilityZoneHasBeenSet ( ) const
inline

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.

Definition at line 676 of file UpdateStackRequest.h.

◆ DefaultInstanceProfileArnHasBeenSet()

bool Aws::OpsWorks::Model::UpdateStackRequest::DefaultInstanceProfileArnHasBeenSet ( ) const
inline

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.

Definition at line 253 of file UpdateStackRequest.h.

◆ DefaultOsHasBeenSet()

bool Aws::OpsWorks::Model::UpdateStackRequest::DefaultOsHasBeenSet ( ) const
inline

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 2018.03, Amazon Linux 2017.09, 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 about how to use custom AMIs with OpsWorks, see Using Custom AMIs.

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

Definition at line 352 of file UpdateStackRequest.h.

◆ DefaultRootDeviceTypeHasBeenSet()

bool Aws::OpsWorks::Model::UpdateStackRequest::DefaultRootDeviceTypeHasBeenSet ( ) const
inline

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.

Definition at line 1232 of file UpdateStackRequest.h.

◆ DefaultSshKeyNameHasBeenSet()

bool Aws::OpsWorks::Model::UpdateStackRequest::DefaultSshKeyNameHasBeenSet ( ) const
inline

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.

Definition at line 1123 of file UpdateStackRequest.h.

◆ DefaultSubnetIdHasBeenSet()

bool Aws::OpsWorks::Model::UpdateStackRequest::DefaultSubnetIdHasBeenSet ( ) const
inline

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.

Definition at line 757 of file UpdateStackRequest.h.

◆ GetAgentVersion()

const Aws::String& Aws::OpsWorks::Model::UpdateStackRequest::GetAgentVersion ( ) const
inline

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.

Definition at line 1372 of file UpdateStackRequest.h.

◆ GetAttributes()

const Aws::Map<StackAttributesKeys, Aws::String>& Aws::OpsWorks::Model::UpdateStackRequest::GetAttributes ( ) const
inline

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

Definition at line 129 of file UpdateStackRequest.h.

◆ GetChefConfiguration()

const ChefConfiguration& Aws::OpsWorks::Model::UpdateStackRequest::GetChefConfiguration ( ) const
inline

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.

Definition at line 965 of file UpdateStackRequest.h.

◆ GetConfigurationManager()

const StackConfigurationManager& Aws::OpsWorks::Model::UpdateStackRequest::GetConfigurationManager ( ) const
inline

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

Definition at line 915 of file UpdateStackRequest.h.

◆ GetCustomCookbooksSource()

const Source& Aws::OpsWorks::Model::UpdateStackRequest::GetCustomCookbooksSource ( ) const
inline

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

Definition at line 1042 of file UpdateStackRequest.h.

◆ GetCustomJson()

const Aws::String& Aws::OpsWorks::Model::UpdateStackRequest::GetCustomJson ( ) const
inline

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 about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

Definition at line 829 of file UpdateStackRequest.h.

◆ GetDefaultAvailabilityZone()

const Aws::String& Aws::OpsWorks::Model::UpdateStackRequest::GetDefaultAvailabilityZone ( ) const
inline

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.

Definition at line 666 of file UpdateStackRequest.h.

◆ GetDefaultInstanceProfileArn()

const Aws::String& Aws::OpsWorks::Model::UpdateStackRequest::GetDefaultInstanceProfileArn ( ) const
inline

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.

Definition at line 245 of file UpdateStackRequest.h.

◆ GetDefaultOs()

const Aws::String& Aws::OpsWorks::Model::UpdateStackRequest::GetDefaultOs ( ) const
inline

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 2018.03, Amazon Linux 2017.09, 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 about how to use custom AMIs with OpsWorks, see Using Custom AMIs.

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

Definition at line 327 of file UpdateStackRequest.h.

◆ GetDefaultRootDeviceType()

const RootDeviceType& Aws::OpsWorks::Model::UpdateStackRequest::GetDefaultRootDeviceType ( ) const
inline

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.

Definition at line 1223 of file UpdateStackRequest.h.

◆ GetDefaultSshKeyName()

const Aws::String& Aws::OpsWorks::Model::UpdateStackRequest::GetDefaultSshKeyName ( ) const
inline

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.

Definition at line 1108 of file UpdateStackRequest.h.

◆ GetDefaultSubnetId()

const Aws::String& Aws::OpsWorks::Model::UpdateStackRequest::GetDefaultSubnetId ( ) const
inline

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.

Definition at line 747 of file UpdateStackRequest.h.

◆ GetHostnameTheme()

const Aws::String& Aws::OpsWorks::Model::UpdateStackRequest::GetHostnameTheme ( ) const
inline

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_and_Titans

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

Definition at line 522 of file UpdateStackRequest.h.

◆ GetName()

const Aws::String& Aws::OpsWorks::Model::UpdateStackRequest::GetName ( ) const
inline

The stack's new name.

Definition at line 87 of file UpdateStackRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::OpsWorks::Model::UpdateStackRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::OpsWorks::OpsWorksRequest.

◆ GetServiceRequestName()

virtual const char* Aws::OpsWorks::Model::UpdateStackRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file UpdateStackRequest.h.

◆ GetServiceRoleArn()

const Aws::String& Aws::OpsWorks::Model::UpdateStackRequest::GetServiceRoleArn ( ) const
inline

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

Definition at line 201 of file UpdateStackRequest.h.

◆ GetStackId()

const Aws::String& Aws::OpsWorks::Model::UpdateStackRequest::GetStackId ( ) const
inline

The stack ID.

Definition at line 46 of file UpdateStackRequest.h.

◆ GetUseCustomCookbooks()

bool Aws::OpsWorks::Model::UpdateStackRequest::GetUseCustomCookbooks ( ) const
inline

Whether the stack uses custom cookbooks.

Definition at line 1016 of file UpdateStackRequest.h.

◆ GetUseOpsworksSecurityGroups()

bool Aws::OpsWorks::Model::UpdateStackRequest::GetUseOpsworksSecurityGroups ( ) const
inline

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.

Definition at line 1290 of file UpdateStackRequest.h.

◆ HostnameThemeHasBeenSet()

bool Aws::OpsWorks::Model::UpdateStackRequest::HostnameThemeHasBeenSet ( ) const
inline

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_and_Titans

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

Definition at line 541 of file UpdateStackRequest.h.

◆ NameHasBeenSet()

bool Aws::OpsWorks::Model::UpdateStackRequest::NameHasBeenSet ( ) const
inline

The stack's new name.

Definition at line 92 of file UpdateStackRequest.h.

◆ SerializePayload()

Aws::String Aws::OpsWorks::Model::UpdateStackRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ ServiceRoleArnHasBeenSet()

bool Aws::OpsWorks::Model::UpdateStackRequest::ServiceRoleArnHasBeenSet ( ) const
inline

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

Definition at line 206 of file UpdateStackRequest.h.

◆ SetAgentVersion() [1/3]

void Aws::OpsWorks::Model::UpdateStackRequest::SetAgentVersion ( const Aws::String value)
inline

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.

Definition at line 1408 of file UpdateStackRequest.h.

◆ SetAgentVersion() [2/3]

void Aws::OpsWorks::Model::UpdateStackRequest::SetAgentVersion ( Aws::String &&  value)
inline

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.

Definition at line 1426 of file UpdateStackRequest.h.

◆ SetAgentVersion() [3/3]

void Aws::OpsWorks::Model::UpdateStackRequest::SetAgentVersion ( const char *  value)
inline

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.

Definition at line 1444 of file UpdateStackRequest.h.

◆ SetAttributes() [1/2]

void Aws::OpsWorks::Model::UpdateStackRequest::SetAttributes ( const Aws::Map< StackAttributesKeys, Aws::String > &  value)
inline

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

Definition at line 141 of file UpdateStackRequest.h.

◆ SetAttributes() [2/2]

void Aws::OpsWorks::Model::UpdateStackRequest::SetAttributes ( Aws::Map< StackAttributesKeys, Aws::String > &&  value)
inline

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

Definition at line 147 of file UpdateStackRequest.h.

◆ SetChefConfiguration() [1/2]

void Aws::OpsWorks::Model::UpdateStackRequest::SetChefConfiguration ( const ChefConfiguration value)
inline

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.

Definition at line 983 of file UpdateStackRequest.h.

◆ SetChefConfiguration() [2/2]

void Aws::OpsWorks::Model::UpdateStackRequest::SetChefConfiguration ( ChefConfiguration &&  value)
inline

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.

Definition at line 992 of file UpdateStackRequest.h.

◆ SetConfigurationManager() [1/2]

void Aws::OpsWorks::Model::UpdateStackRequest::SetConfigurationManager ( const StackConfigurationManager value)
inline

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

Definition at line 931 of file UpdateStackRequest.h.

◆ SetConfigurationManager() [2/2]

void Aws::OpsWorks::Model::UpdateStackRequest::SetConfigurationManager ( StackConfigurationManager &&  value)
inline

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

Definition at line 939 of file UpdateStackRequest.h.

◆ SetCustomCookbooksSource() [1/2]

void Aws::OpsWorks::Model::UpdateStackRequest::SetCustomCookbooksSource ( const Source value)
inline

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

Definition at line 1062 of file UpdateStackRequest.h.

◆ SetCustomCookbooksSource() [2/2]

void Aws::OpsWorks::Model::UpdateStackRequest::SetCustomCookbooksSource ( Source &&  value)
inline

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

Definition at line 1072 of file UpdateStackRequest.h.

◆ SetCustomJson() [1/3]

void Aws::OpsWorks::Model::UpdateStackRequest::SetCustomJson ( const Aws::String value)
inline

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 about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

Definition at line 851 of file UpdateStackRequest.h.

◆ SetCustomJson() [2/3]

void Aws::OpsWorks::Model::UpdateStackRequest::SetCustomJson ( Aws::String &&  value)
inline

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 about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

Definition at line 862 of file UpdateStackRequest.h.

◆ SetCustomJson() [3/3]

void Aws::OpsWorks::Model::UpdateStackRequest::SetCustomJson ( const char *  value)
inline

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 about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

Definition at line 873 of file UpdateStackRequest.h.

◆ SetDefaultAvailabilityZone() [1/3]

void Aws::OpsWorks::Model::UpdateStackRequest::SetDefaultAvailabilityZone ( const Aws::String value)
inline

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.

Definition at line 686 of file UpdateStackRequest.h.

◆ SetDefaultAvailabilityZone() [2/3]

void Aws::OpsWorks::Model::UpdateStackRequest::SetDefaultAvailabilityZone ( Aws::String &&  value)
inline

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.

Definition at line 696 of file UpdateStackRequest.h.

◆ SetDefaultAvailabilityZone() [3/3]

void Aws::OpsWorks::Model::UpdateStackRequest::SetDefaultAvailabilityZone ( const char *  value)
inline

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.

Definition at line 706 of file UpdateStackRequest.h.

◆ SetDefaultInstanceProfileArn() [1/3]

void Aws::OpsWorks::Model::UpdateStackRequest::SetDefaultInstanceProfileArn ( const Aws::String value)
inline

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.

Definition at line 261 of file UpdateStackRequest.h.

◆ SetDefaultInstanceProfileArn() [2/3]

void Aws::OpsWorks::Model::UpdateStackRequest::SetDefaultInstanceProfileArn ( Aws::String &&  value)
inline

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.

Definition at line 269 of file UpdateStackRequest.h.

◆ SetDefaultInstanceProfileArn() [3/3]

void Aws::OpsWorks::Model::UpdateStackRequest::SetDefaultInstanceProfileArn ( const char *  value)
inline

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.

Definition at line 277 of file UpdateStackRequest.h.

◆ SetDefaultOs() [1/3]

void Aws::OpsWorks::Model::UpdateStackRequest::SetDefaultOs ( const Aws::String value)
inline

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 2018.03, Amazon Linux 2017.09, 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 about how to use custom AMIs with OpsWorks, see Using Custom AMIs.

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

Definition at line 377 of file UpdateStackRequest.h.

◆ SetDefaultOs() [2/3]

void Aws::OpsWorks::Model::UpdateStackRequest::SetDefaultOs ( Aws::String &&  value)
inline

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 2018.03, Amazon Linux 2017.09, 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 about how to use custom AMIs with OpsWorks, see Using Custom AMIs.

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

Definition at line 402 of file UpdateStackRequest.h.

◆ SetDefaultOs() [3/3]

void Aws::OpsWorks::Model::UpdateStackRequest::SetDefaultOs ( const char *  value)
inline

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 2018.03, Amazon Linux 2017.09, 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 about how to use custom AMIs with OpsWorks, see Using Custom AMIs.

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

Definition at line 427 of file UpdateStackRequest.h.

◆ SetDefaultRootDeviceType() [1/2]

void Aws::OpsWorks::Model::UpdateStackRequest::SetDefaultRootDeviceType ( const RootDeviceType value)
inline

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.

Definition at line 1241 of file UpdateStackRequest.h.

◆ SetDefaultRootDeviceType() [2/2]

void Aws::OpsWorks::Model::UpdateStackRequest::SetDefaultRootDeviceType ( RootDeviceType &&  value)
inline

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.

Definition at line 1250 of file UpdateStackRequest.h.

◆ SetDefaultSshKeyName() [1/3]

void Aws::OpsWorks::Model::UpdateStackRequest::SetDefaultSshKeyName ( const Aws::String value)
inline

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.

Definition at line 1138 of file UpdateStackRequest.h.

◆ SetDefaultSshKeyName() [2/3]

void Aws::OpsWorks::Model::UpdateStackRequest::SetDefaultSshKeyName ( Aws::String &&  value)
inline

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.

Definition at line 1153 of file UpdateStackRequest.h.

◆ SetDefaultSshKeyName() [3/3]

void Aws::OpsWorks::Model::UpdateStackRequest::SetDefaultSshKeyName ( const char *  value)
inline

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.

Definition at line 1168 of file UpdateStackRequest.h.

◆ SetDefaultSubnetId() [1/3]

void Aws::OpsWorks::Model::UpdateStackRequest::SetDefaultSubnetId ( const Aws::String value)
inline

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.

Definition at line 767 of file UpdateStackRequest.h.

◆ SetDefaultSubnetId() [2/3]

void Aws::OpsWorks::Model::UpdateStackRequest::SetDefaultSubnetId ( Aws::String &&  value)
inline

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.

Definition at line 777 of file UpdateStackRequest.h.

◆ SetDefaultSubnetId() [3/3]

void Aws::OpsWorks::Model::UpdateStackRequest::SetDefaultSubnetId ( const char *  value)
inline

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.

Definition at line 787 of file UpdateStackRequest.h.

◆ SetHostnameTheme() [1/3]

void Aws::OpsWorks::Model::UpdateStackRequest::SetHostnameTheme ( const Aws::String value)
inline

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_and_Titans

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

Definition at line 560 of file UpdateStackRequest.h.

◆ SetHostnameTheme() [2/3]

void Aws::OpsWorks::Model::UpdateStackRequest::SetHostnameTheme ( Aws::String &&  value)
inline

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_and_Titans

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

Definition at line 579 of file UpdateStackRequest.h.

◆ SetHostnameTheme() [3/3]

void Aws::OpsWorks::Model::UpdateStackRequest::SetHostnameTheme ( const char *  value)
inline

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_and_Titans

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

Definition at line 598 of file UpdateStackRequest.h.

◆ SetName() [1/3]

void Aws::OpsWorks::Model::UpdateStackRequest::SetName ( const Aws::String value)
inline

The stack's new name.

Definition at line 97 of file UpdateStackRequest.h.

◆ SetName() [2/3]

void Aws::OpsWorks::Model::UpdateStackRequest::SetName ( Aws::String &&  value)
inline

The stack's new name.

Definition at line 102 of file UpdateStackRequest.h.

◆ SetName() [3/3]

void Aws::OpsWorks::Model::UpdateStackRequest::SetName ( const char *  value)
inline

The stack's new name.

Definition at line 107 of file UpdateStackRequest.h.

◆ SetServiceRoleArn() [1/3]

void Aws::OpsWorks::Model::UpdateStackRequest::SetServiceRoleArn ( const Aws::String value)
inline

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

Definition at line 211 of file UpdateStackRequest.h.

◆ SetServiceRoleArn() [2/3]

void Aws::OpsWorks::Model::UpdateStackRequest::SetServiceRoleArn ( Aws::String &&  value)
inline

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

Definition at line 216 of file UpdateStackRequest.h.

◆ SetServiceRoleArn() [3/3]

void Aws::OpsWorks::Model::UpdateStackRequest::SetServiceRoleArn ( const char *  value)
inline

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

Definition at line 221 of file UpdateStackRequest.h.

◆ SetStackId() [1/3]

void Aws::OpsWorks::Model::UpdateStackRequest::SetStackId ( const Aws::String value)
inline

The stack ID.

Definition at line 56 of file UpdateStackRequest.h.

◆ SetStackId() [2/3]

void Aws::OpsWorks::Model::UpdateStackRequest::SetStackId ( Aws::String &&  value)
inline

The stack ID.

Definition at line 61 of file UpdateStackRequest.h.

◆ SetStackId() [3/3]

void Aws::OpsWorks::Model::UpdateStackRequest::SetStackId ( const char *  value)
inline

The stack ID.

Definition at line 66 of file UpdateStackRequest.h.

◆ SetUseCustomCookbooks()

void Aws::OpsWorks::Model::UpdateStackRequest::SetUseCustomCookbooks ( bool  value)
inline

Whether the stack uses custom cookbooks.

Definition at line 1026 of file UpdateStackRequest.h.

◆ SetUseOpsworksSecurityGroups()

void Aws::OpsWorks::Model::UpdateStackRequest::SetUseOpsworksSecurityGroups ( bool  value)
inline

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.

Definition at line 1332 of file UpdateStackRequest.h.

◆ StackIdHasBeenSet()

bool Aws::OpsWorks::Model::UpdateStackRequest::StackIdHasBeenSet ( ) const
inline

The stack ID.

Definition at line 51 of file UpdateStackRequest.h.

◆ UseCustomCookbooksHasBeenSet()

bool Aws::OpsWorks::Model::UpdateStackRequest::UseCustomCookbooksHasBeenSet ( ) const
inline

Whether the stack uses custom cookbooks.

Definition at line 1021 of file UpdateStackRequest.h.

◆ UseOpsworksSecurityGroupsHasBeenSet()

bool Aws::OpsWorks::Model::UpdateStackRequest::UseOpsworksSecurityGroupsHasBeenSet ( ) const
inline

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.

Definition at line 1311 of file UpdateStackRequest.h.

◆ WithAgentVersion() [1/3]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithAgentVersion ( const Aws::String value)
inline

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.

Definition at line 1462 of file UpdateStackRequest.h.

◆ WithAgentVersion() [2/3]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithAgentVersion ( Aws::String &&  value)
inline

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.

Definition at line 1480 of file UpdateStackRequest.h.

◆ WithAgentVersion() [3/3]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithAgentVersion ( const char *  value)
inline

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.

Definition at line 1498 of file UpdateStackRequest.h.

◆ WithAttributes() [1/2]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithAttributes ( const Aws::Map< StackAttributesKeys, Aws::String > &  value)
inline

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

Definition at line 153 of file UpdateStackRequest.h.

◆ WithAttributes() [2/2]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithAttributes ( Aws::Map< StackAttributesKeys, Aws::String > &&  value)
inline

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

Definition at line 159 of file UpdateStackRequest.h.

◆ WithChefConfiguration() [1/2]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithChefConfiguration ( const ChefConfiguration value)
inline

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.

Definition at line 1001 of file UpdateStackRequest.h.

◆ WithChefConfiguration() [2/2]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithChefConfiguration ( ChefConfiguration &&  value)
inline

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.

Definition at line 1010 of file UpdateStackRequest.h.

◆ WithConfigurationManager() [1/2]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithConfigurationManager ( const StackConfigurationManager value)
inline

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

Definition at line 947 of file UpdateStackRequest.h.

◆ WithConfigurationManager() [2/2]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithConfigurationManager ( StackConfigurationManager &&  value)
inline

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

Definition at line 955 of file UpdateStackRequest.h.

◆ WithCustomCookbooksSource() [1/2]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithCustomCookbooksSource ( const Source value)
inline

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

Definition at line 1082 of file UpdateStackRequest.h.

◆ WithCustomCookbooksSource() [2/2]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithCustomCookbooksSource ( Source &&  value)
inline

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

Definition at line 1092 of file UpdateStackRequest.h.

◆ WithCustomJson() [1/3]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithCustomJson ( const Aws::String value)
inline

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 about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

Definition at line 884 of file UpdateStackRequest.h.

◆ WithCustomJson() [2/3]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithCustomJson ( Aws::String &&  value)
inline

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 about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

Definition at line 895 of file UpdateStackRequest.h.

◆ WithCustomJson() [3/3]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithCustomJson ( const char *  value)
inline

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 about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

Definition at line 906 of file UpdateStackRequest.h.

◆ WithDefaultAvailabilityZone() [1/3]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithDefaultAvailabilityZone ( const Aws::String value)
inline

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.

Definition at line 716 of file UpdateStackRequest.h.

◆ WithDefaultAvailabilityZone() [2/3]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithDefaultAvailabilityZone ( Aws::String &&  value)
inline

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.

Definition at line 726 of file UpdateStackRequest.h.

◆ WithDefaultAvailabilityZone() [3/3]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithDefaultAvailabilityZone ( const char *  value)
inline

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.

Definition at line 736 of file UpdateStackRequest.h.

◆ WithDefaultInstanceProfileArn() [1/3]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithDefaultInstanceProfileArn ( const Aws::String value)
inline

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.

Definition at line 285 of file UpdateStackRequest.h.

◆ WithDefaultInstanceProfileArn() [2/3]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithDefaultInstanceProfileArn ( Aws::String &&  value)
inline

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.

Definition at line 293 of file UpdateStackRequest.h.

◆ WithDefaultInstanceProfileArn() [3/3]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithDefaultInstanceProfileArn ( const char *  value)
inline

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.

Definition at line 301 of file UpdateStackRequest.h.

◆ WithDefaultOs() [1/3]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithDefaultOs ( const Aws::String value)
inline

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 2018.03, Amazon Linux 2017.09, 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 about how to use custom AMIs with OpsWorks, see Using Custom AMIs.

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

Definition at line 452 of file UpdateStackRequest.h.

◆ WithDefaultOs() [2/3]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithDefaultOs ( Aws::String &&  value)
inline

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 2018.03, Amazon Linux 2017.09, 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 about how to use custom AMIs with OpsWorks, see Using Custom AMIs.

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

Definition at line 477 of file UpdateStackRequest.h.

◆ WithDefaultOs() [3/3]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithDefaultOs ( const char *  value)
inline

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 2018.03, Amazon Linux 2017.09, 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 about how to use custom AMIs with OpsWorks, see Using Custom AMIs.

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

Definition at line 502 of file UpdateStackRequest.h.

◆ WithDefaultRootDeviceType() [1/2]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithDefaultRootDeviceType ( const RootDeviceType value)
inline

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.

Definition at line 1259 of file UpdateStackRequest.h.

◆ WithDefaultRootDeviceType() [2/2]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithDefaultRootDeviceType ( RootDeviceType &&  value)
inline

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.

Definition at line 1268 of file UpdateStackRequest.h.

◆ WithDefaultSshKeyName() [1/3]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithDefaultSshKeyName ( const Aws::String value)
inline

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.

Definition at line 1183 of file UpdateStackRequest.h.

◆ WithDefaultSshKeyName() [2/3]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithDefaultSshKeyName ( Aws::String &&  value)
inline

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.

Definition at line 1198 of file UpdateStackRequest.h.

◆ WithDefaultSshKeyName() [3/3]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithDefaultSshKeyName ( const char *  value)
inline

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.

Definition at line 1213 of file UpdateStackRequest.h.

◆ WithDefaultSubnetId() [1/3]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithDefaultSubnetId ( const Aws::String value)
inline

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.

Definition at line 797 of file UpdateStackRequest.h.

◆ WithDefaultSubnetId() [2/3]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithDefaultSubnetId ( Aws::String &&  value)
inline

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.

Definition at line 807 of file UpdateStackRequest.h.

◆ WithDefaultSubnetId() [3/3]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithDefaultSubnetId ( const char *  value)
inline

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.

Definition at line 817 of file UpdateStackRequest.h.

◆ WithHostnameTheme() [1/3]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithHostnameTheme ( const Aws::String value)
inline

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_and_Titans

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

Definition at line 617 of file UpdateStackRequest.h.

◆ WithHostnameTheme() [2/3]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithHostnameTheme ( Aws::String &&  value)
inline

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_and_Titans

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

Definition at line 636 of file UpdateStackRequest.h.

◆ WithHostnameTheme() [3/3]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithHostnameTheme ( const char *  value)
inline

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_and_Titans

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

Definition at line 655 of file UpdateStackRequest.h.

◆ WithName() [1/3]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithName ( const Aws::String value)
inline

The stack's new name.

Definition at line 112 of file UpdateStackRequest.h.

◆ WithName() [2/3]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithName ( Aws::String &&  value)
inline

The stack's new name.

Definition at line 117 of file UpdateStackRequest.h.

◆ WithName() [3/3]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithName ( const char *  value)
inline

The stack's new name.

Definition at line 122 of file UpdateStackRequest.h.

◆ WithServiceRoleArn() [1/3]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithServiceRoleArn ( const Aws::String value)
inline

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

Definition at line 226 of file UpdateStackRequest.h.

◆ WithServiceRoleArn() [2/3]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithServiceRoleArn ( Aws::String &&  value)
inline

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

Definition at line 231 of file UpdateStackRequest.h.

◆ WithServiceRoleArn() [3/3]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithServiceRoleArn ( const char *  value)
inline

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

Definition at line 236 of file UpdateStackRequest.h.

◆ WithStackId() [1/3]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithStackId ( const Aws::String value)
inline

The stack ID.

Definition at line 71 of file UpdateStackRequest.h.

◆ WithStackId() [2/3]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithStackId ( Aws::String &&  value)
inline

The stack ID.

Definition at line 76 of file UpdateStackRequest.h.

◆ WithStackId() [3/3]

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithStackId ( const char *  value)
inline

The stack ID.

Definition at line 81 of file UpdateStackRequest.h.

◆ WithUseCustomCookbooks()

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithUseCustomCookbooks ( bool  value)
inline

Whether the stack uses custom cookbooks.

Definition at line 1031 of file UpdateStackRequest.h.

◆ WithUseOpsworksSecurityGroups()

UpdateStackRequest& Aws::OpsWorks::Model::UpdateStackRequest::WithUseOpsworksSecurityGroups ( bool  value)
inline

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.

Definition at line 1353 of file UpdateStackRequest.h.


The documentation for this class was generated from the following file: