amazonka-opsworks-1.3.0: Amazon OpsWorks SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <>
Portabilitynon-portable (GHC extensions)
Safe HaskellNone




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.

See: AWS API Reference for CreateInstance.


Creating a Request

Request Lenses

ciInstallUpdatesOnBoot :: Lens' CreateInstance (Maybe Bool) Source

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.

ciVirtualizationType :: Lens' CreateInstance (Maybe Text) Source

The instance's virtualization type, paravirtual or hvm.

ciHostname :: Lens' CreateInstance (Maybe Text) Source

The instance host name.

ciSSHKeyName :: Lens' CreateInstance (Maybe Text) Source

The instance's Amazon EC2 key-pair name.

ciAgentVersion :: Lens' CreateInstance (Maybe Text) Source

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

ciSubnetId :: Lens' CreateInstance (Maybe Text) Source

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 to launch the instance in a different subnet.

ciEBSOptimized :: Lens' CreateInstance (Maybe Bool) Source

Whether to create an Amazon EBS-optimized instance.

ciOS :: Lens' CreateInstance (Maybe Text) Source

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

For more information on the supported operating systems, see AWS OpsWorks 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. For more information on the supported operating systems, see Operating SystemsFor more information on how to use custom AMIs with AWS OpsWorks, see Using Custom AMIs.

ciAvailabilityZone :: Lens' CreateInstance (Maybe Text) Source

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

ciAutoScalingType :: Lens' CreateInstance (Maybe AutoScalingType) Source

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

ciArchitecture :: Lens' CreateInstance (Maybe Architecture) Source

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.

ciAMIId :: Lens' CreateInstance (Maybe Text) Source

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.

ciRootDeviceType :: Lens' CreateInstance (Maybe RootDeviceType) Source

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

ciBlockDeviceMappings :: Lens' CreateInstance [BlockDeviceMapping] Source

An array of BlockDeviceMapping objects that specify the instance's block devices. For more information, see Block Device Mapping.

ciLayerIds :: Lens' CreateInstance [Text] Source

An array that contains the instance's layer IDs.

ciInstanceType :: Lens' CreateInstance Text Source

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.

Destructuring the Response

createInstanceResponse Source

Creates a value of CreateInstanceResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

Response Lenses