API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see

We welcome your feedback on this new version of the documentation. Send your comments to


import ""

type CreateInstanceInput struct { AgentVersion *string `type:"string"` AmiId *string `type:"string"` Architecture *string `type:"string" enum:"Architecture"` AutoScalingType *string `type:"string" enum:"AutoScalingType"` AvailabilityZone *string `type:"string"` BlockDeviceMappings []*BlockDeviceMapping `type:"list"` EbsOptimized *bool `type:"boolean"` Hostname *string `type:"string"` InstallUpdatesOnBoot *bool `type:"boolean"` InstanceType *string `type:"string" required:"true"` LayerIds []*string `type:"list" required:"true"` Os *string `type:"string"` RootDeviceType *string `type:"string" enum:"RootDeviceType"` SshKeyName *string `type:"string"` StackId *string `type:"string" required:"true"` SubnetId *string `type:"string"` Tenancy *string `type:"string"` VirtualizationType *string `type:"string"` }


Type: *string

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.


Type: *string

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.


Type: *string

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 (


Type: *string

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


Type: *string

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


Describes a block device mapping. This data type maps directly to the Amazon EC2 BlockDeviceMapping ( data type.


Type: *bool

Whether to create an Amazon EBS-optimized instance.


Type: *string

The instance host name.


Type: *bool

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.


Type: *string

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.

InstanceType is a required field


Type: []*string

An array that contains the instance's layer IDs.

LayerIds is a required field


Type: *string

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

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 Systems ( more information about how to use custom AMIs with AWS OpsWorks Stacks, see Using Custom AMIs (


Type: *string

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


Type: *string

The instance's Amazon EC2 key-pair name.


Type: *string

The stack ID.

StackId is a required field


Type: *string

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.


Type: *string

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 (


Type: *string

The instance's virtualization type, paravirtual or hvm.



func (s CreateInstanceInput) GoString() string

GoString returns the string representation


func (s *CreateInstanceInput) SetAgentVersion(v string) *CreateInstanceInput

SetAgentVersion sets the AgentVersion field's value.


func (s *CreateInstanceInput) SetAmiId(v string) *CreateInstanceInput

SetAmiId sets the AmiId field's value.


func (s *CreateInstanceInput) SetArchitecture(v string) *CreateInstanceInput

SetArchitecture sets the Architecture field's value.


func (s *CreateInstanceInput) SetAutoScalingType(v string) *CreateInstanceInput

SetAutoScalingType sets the AutoScalingType field's value.


func (s *CreateInstanceInput) SetAvailabilityZone(v string) *CreateInstanceInput

SetAvailabilityZone sets the AvailabilityZone field's value.


func (s *CreateInstanceInput) SetBlockDeviceMappings(v []*BlockDeviceMapping) *CreateInstanceInput

SetBlockDeviceMappings sets the BlockDeviceMappings field's value.


func (s *CreateInstanceInput) SetEbsOptimized(v bool) *CreateInstanceInput

SetEbsOptimized sets the EbsOptimized field's value.


func (s *CreateInstanceInput) SetHostname(v string) *CreateInstanceInput

SetHostname sets the Hostname field's value.


func (s *CreateInstanceInput) SetInstallUpdatesOnBoot(v bool) *CreateInstanceInput

SetInstallUpdatesOnBoot sets the InstallUpdatesOnBoot field's value.


func (s *CreateInstanceInput) SetInstanceType(v string) *CreateInstanceInput

SetInstanceType sets the InstanceType field's value.


func (s *CreateInstanceInput) SetLayerIds(v []*string) *CreateInstanceInput

SetLayerIds sets the LayerIds field's value.


func (s *CreateInstanceInput) SetOs(v string) *CreateInstanceInput

SetOs sets the Os field's value.


func (s *CreateInstanceInput) SetRootDeviceType(v string) *CreateInstanceInput

SetRootDeviceType sets the RootDeviceType field's value.


func (s *CreateInstanceInput) SetSshKeyName(v string) *CreateInstanceInput

SetSshKeyName sets the SshKeyName field's value.


func (s *CreateInstanceInput) SetStackId(v string) *CreateInstanceInput

SetStackId sets the StackId field's value.


func (s *CreateInstanceInput) SetSubnetId(v string) *CreateInstanceInput

SetSubnetId sets the SubnetId field's value.


func (s *CreateInstanceInput) SetTenancy(v string) *CreateInstanceInput

SetTenancy sets the Tenancy field's value.


func (s *CreateInstanceInput) SetVirtualizationType(v string) *CreateInstanceInput

SetVirtualizationType sets the VirtualizationType field's value.


func (s CreateInstanceInput) String() string

String returns the string representation


func (s *CreateInstanceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: