CreateInstance
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.
Request Syntax
{
"AgentVersion": "string
",
"AmiId": "string
",
"Architecture": "string
",
"AutoScalingType": "string
",
"AvailabilityZone": "string
",
"BlockDeviceMappings": [
{
"DeviceName": "string
",
"Ebs": {
"DeleteOnTermination": boolean
,
"Iops": number
,
"SnapshotId": "string
",
"VolumeSize": number
,
"VolumeType": "string
"
},
"NoDevice": "string
",
"VirtualName": "string
"
}
],
"EbsOptimized": boolean
,
"Hostname": "string
",
"InstallUpdatesOnBoot": boolean
,
"InstanceType": "string
",
"LayerIds": [ "string
" ],
"Os": "string
",
"RootDeviceType": "string
",
"SshKeyName": "string
",
"StackId": "string
",
"SubnetId": "string
",
"Tenancy": "string
",
"VirtualizationType": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- 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 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
Required: No
-
- 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.
Note
If you specify a custom AMI, you must set
Os
toCustom
.Type: String
Required: No
- 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.Type: String
Valid Values:
x86_64 | i386
Required: No
- AutoScalingType
-
For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
Type: String
Valid Values:
load | timer
Required: No
- AvailabilityZone
-
The instance Availability Zone. For more information, see Regions and Endpoints.
Type: String
Required: No
- 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.Type: Array of BlockDeviceMapping objects
Required: No
- EbsOptimized
-
Whether to create an Amazon EBS-optimized instance.
Type: Boolean
Required: No
- Hostname
-
The instance host name. The following are character limits for instance host names.
-
Linux-based instances: 63 characters
-
Windows-based instances: 15 characters
Type: String
Required: No
-
- 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 tofalse
. You must then update your instances manually by using CreateDeployment to run theupdate_dependencies
stack command or by manually runningyum
(Amazon Linux) orapt-get
(Ubuntu) on the instances.Note
We strongly recommend using the default value of
true
to ensure that your instances have the latest security updates.Type: Boolean
Required: No
- 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.Type: String
Required: Yes
- LayerIds
-
An array that contains the instance's layer IDs.
Type: Array of strings
Required: Yes
- 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
Amazon Linux 2
,Amazon Linux 2018.03
,Amazon Linux 2017.09
,Amazon Linux 2017.03
,Amazon Linux 2016.09
,Amazon Linux 2016.03
,Amazon Linux 2015.09
, orAmazon Linux 2015.03
. -
A supported Ubuntu operating system, such as
Ubuntu 18.04 LTS
,Ubuntu 16.04 LTS
,Ubuntu 14.04 LTS
, orUbuntu 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
, orMicrosoft Windows Server 2012 R2 with SQL Server Web
. -
A custom AMI:
Custom
.
Not all operating systems are supported with all versions of Chef. 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 isCustom
. For more information about how to use custom AMIs with AWS OpsWorks Stacks, see Using Custom AMIs.Type: String
Required: No
-
- RootDeviceType
-
The instance root device type. For more information, see Storage for the Root Device.
Type: String
Valid Values:
ebs | instance-store
Required: No
- SshKeyName
-
The instance's Amazon EC2 key-pair name.
Type: String
Required: No
- StackId
-
The stack ID.
Type: String
Required: Yes
- 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.
Type: String
Required: No
- 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
, orhost
. 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 Overviewand Amazon EC2 Dedicated Hosts . For more information about dedicated instances, see Dedicated Instances and Amazon EC2 Dedicated Instances . Type: String
Required: No
- VirtualizationType
-
The instance's virtualization type,
paravirtual
orhvm
.Type: String
Required: No
Response Syntax
{
"InstanceId": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- InstanceId
-
The instance ID.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceNotFoundException
-
Indicates that a resource was not found.
HTTP Status Code: 400
- ValidationException
-
Indicates that a request was not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: