AWS SDK Version 2 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

.NET Framework 4.5
 
Container for the parameters to the UpdateStack operation. Updates a specified stack.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.OpsWorks.AmazonOpsWorksRequest
      Amazon.OpsWorks.Model.UpdateStackRequest

Namespace: Amazon.OpsWorks.Model
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public class UpdateStackRequest : AmazonOpsWorksRequest
         IRequestEvents

The UpdateStackRequest type exposes the following members

Constructors

NameDescription
Public Method UpdateStackRequest()

Properties

NameTypeDescription
Public Property AgentVersion System.String Gets and sets the property AgentVersion.

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

  • Auto-update - Set this parameter to LATEST. AWS OpsWorks 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 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.

You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.
Public Property Attributes System.Collections.Generic.Dictionary<System.String, System.String> Gets and sets the property Attributes.

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

Public Property ChefConfiguration Amazon.OpsWorks.Model.ChefConfiguration Gets and sets the property 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.

Public Property ConfigurationManager Amazon.OpsWorks.Model.StackConfigurationManager Gets and sets the property 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.

Public Property CustomCookbooksSource Amazon.OpsWorks.Model.Source Gets and sets the property CustomCookbooksSource.
Public Property CustomJson System.String Gets and sets the property 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 and escape characters such as '"':

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

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

Public Property DefaultAvailabilityZone System.String Gets and sets the property 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.

Public Property DefaultInstanceProfileArn System.String Gets and sets the property 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.

Public Property DefaultOs System.String Gets and sets the property 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 2015.03
    
    , Red Hat Enterprise Linux 7,
    Ubuntu 12.04
                LTS
    
    , or Ubuntu 14.04 LTS.
  • Microsoft Windows Server
                2012 R2 Base
    
    .
  • 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 Operating Systems.

Public Property DefaultRootDeviceType Amazon.OpsWorks.RootDeviceType Gets and sets the property 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.

Public Property DefaultSshKeyName System.String Gets and sets the property DefaultSshKeyName.

A default Amazon EC2 key-pair name. The default value is none. If you specify a key-pair name, AWS OpsWorks 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.

Public Property DefaultSubnetId System.String Gets and sets the property 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.

Public Property HostnameTheme System.String Gets and sets the property 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.

Public Property Name System.String Gets and sets the property Name.

The stack's new name.

Public Property ServiceRoleArn System.String Gets and sets the property ServiceRoleArn.

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

Public Property StackId System.String Gets and sets the property StackId.

The stack ID.

Public Property UseCustomCookbooks System.Boolean Gets and sets the property UseCustomCookbooks.

Whether the stack uses custom cookbooks.

Public Property UseOpsworksSecurityGroups System.Boolean Gets and sets the property UseOpsworksSecurityGroups.

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

AWS OpsWorks 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 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 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.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

.NET for Windows Store apps:
Supported in: Windows 8