AWS SDK Version 3 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.

Container for the parameters to the CreateInstance operation. Creates an instance in a specified stack. For more information, see Adding an Instance to a Layer.

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


Namespace: Amazon.OpsWorks.Model
Assembly: AWSSDK.OpsWorks.dll
Version: 3.x.y.z


public class CreateInstanceRequest : AmazonOpsWorksRequest

The CreateInstanceRequest type exposes the following members


Public Method CreateInstanceRequest()


Public Property AgentVersion System.String

Gets and sets the property AgentVersion.

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

  • INHERIT - Use the stack's default agent version setting.

  • version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance.

The default setting is INHERIT. 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.

Public Property AmiId System.String

Gets and sets the property AmiId.

A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see Using Custom AMIs.

If you specify a custom AMI, you must set Os to Custom.

Public Property Architecture Amazon.OpsWorks.Architecture

Gets and sets the property Architecture.

The instance architecture. The default option is x86_64. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

Public Property AutoScalingType Amazon.OpsWorks.AutoScalingType

Gets and sets the property AutoScalingType.

For load-based or time-based instances, the type. Windows stacks can use only time-based instances.

Public Property AvailabilityZone System.String

Gets and sets the property AvailabilityZone.

The instance Availability Zone. For more information, see Regions and Endpoints.

Public Property BlockDeviceMappings System.Collections.Generic.List<Amazon.OpsWorks.Model.BlockDeviceMapping>

Gets and sets the property BlockDeviceMappings.

An array of BlockDeviceMapping objects that specify the instance's block devices. For more information, see Block Device Mapping. Note that block device mappings are not supported for custom AMIs.

Public Property EbsOptimized System.Boolean

Gets and sets the property EbsOptimized.

Whether to create an Amazon EBS-optimized instance.

Public Property Hostname System.String

Gets and sets the property Hostname.

The instance host name.

Public Property InstallUpdatesOnBoot System.Boolean

Gets and sets the property InstallUpdatesOnBoot.

Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

We strongly recommend using the default value of true to ensure that your instances have the latest security updates.

Public Property InstanceType System.String

Gets and sets the property InstanceType.

The instance type, such as t2.micro. For a list of supported instance types, open the stack in the console, choose Instances, and choose + Instance. The Size list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

Public Property LayerIds System.Collections.Generic.List<System.String>

Gets and sets the property LayerIds.

An array that contains the instance's layer IDs.

Public Property Os System.String

Gets and sets the property Os.

The instance's operating system, which must be set to one of the following.

  • A supported Linux operating system: An Amazon Linux version, such as

                Linux 2017.09
    , Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or
                Linux 2015.03

  • A supported Ubuntu operating system, such as Ubuntu 16.04 LTS,

                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
                Windows Server 2012 R2 with SQL Server Web

  • A custom AMI: Custom.

For more information about the supported operating systems, see AWS OpsWorks Stacks Operating Systems.

The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is Custom. For more information about supported operating systems, see Operating SystemsFor more information about how to use custom AMIs with AWS OpsWorks Stacks, see Using Custom AMIs.

Public Property RootDeviceType Amazon.OpsWorks.RootDeviceType

Gets and sets the property RootDeviceType.

The instance root device type. For more information, see Storage for the Root Device.

Public Property SshKeyName System.String

Gets and sets the property SshKeyName.

The instance's Amazon EC2 key-pair name.

Public Property StackId System.String

Gets and sets the property StackId.

The stack ID.

Public Property SubnetId System.String

Gets and sets the property SubnetId.

The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks Stacks to launch the instance in a different subnet.

Public Property Tenancy System.String

Gets and sets the property Tenancy.

The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: dedicated, default, or host. Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see Dedicated Hosts Overview and Amazon EC2 Dedicated Hosts. For more information about dedicated instances, see Dedicated Instances and Amazon EC2 Dedicated Instances.

Public Property VirtualizationType Amazon.OpsWorks.VirtualizationType

Gets and sets the property VirtualizationType.

The instance's virtualization type, paravirtual or hvm.

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms