Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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 .
- createInstance :: Text -> Text -> CreateInstance
- data CreateInstance
- ciInstallUpdatesOnBoot :: Lens' CreateInstance (Maybe Bool)
- ciVirtualizationType :: Lens' CreateInstance (Maybe Text)
- ciHostname :: Lens' CreateInstance (Maybe Text)
- ciSSHKeyName :: Lens' CreateInstance (Maybe Text)
- ciAgentVersion :: Lens' CreateInstance (Maybe Text)
- ciSubnetId :: Lens' CreateInstance (Maybe Text)
- ciEBSOptimized :: Lens' CreateInstance (Maybe Bool)
- ciOS :: Lens' CreateInstance (Maybe Text)
- ciAvailabilityZone :: Lens' CreateInstance (Maybe Text)
- ciTenancy :: Lens' CreateInstance (Maybe Text)
- ciAutoScalingType :: Lens' CreateInstance (Maybe AutoScalingType)
- ciArchitecture :: Lens' CreateInstance (Maybe Architecture)
- ciAMIId :: Lens' CreateInstance (Maybe Text)
- ciRootDeviceType :: Lens' CreateInstance (Maybe RootDeviceType)
- ciBlockDeviceMappings :: Lens' CreateInstance [BlockDeviceMapping]
- ciStackId :: Lens' CreateInstance Text
- ciLayerIds :: Lens' CreateInstance [Text]
- ciInstanceType :: Lens' CreateInstance Text
- createInstanceResponse :: Int -> CreateInstanceResponse
- data CreateInstanceResponse
- cirsInstanceId :: Lens' CreateInstanceResponse (Maybe Text)
- cirsResponseStatus :: Lens' CreateInstanceResponse Int
Creating a Request
Creates a value of CreateInstance
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ciInstallUpdatesOnBoot
- Whether to install operating system and package updates when the instance boots. The default value istrue
. To control when updates are installed, set this value tofalse
. You must then update your instances manually by usingCreateDeployment
to run theupdate_dependencies
stack command or by manually runningyum
(Amazon Linux) orapt-get
(Ubuntu) on the instances.ciVirtualizationType
- The instance's virtualization type,paravirtual
orhvm
.ciHostname
- The instance host name.ciSSHKeyName
- The instance's Amazon EC2 key-pair name.ciAgentVersion
- 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 isINHERIT
. 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, callDescribeAgentVersions
.ciSubnetId
- 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
- Whether to create an Amazon EBS-optimized instance.ciOS
- The instance's operating system, which must be set to one of the following. * A supported Linux operating system: An Amazon Linux version, such asAmazon Linux 2016.03
,Amazon Linux 2015.09
, orAmazon Linux 2015.03
. * A supported Ubuntu operating system, such asUbuntu 16.04 LTS
,Ubuntu 14.04 LTS
, orUbuntu 12.04 LTS
. *CentOS 7
*Red Hat Enterprise Linux 7
* A supported Windows operating system, such asMicrosoft 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
. 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 toCustom
, you must use theCreateInstance
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 on the supported operating systems, see Operating Systems For more information on how to use custom AMIs with AWS OpsWorks, see Using Custom AMIs .ciAvailabilityZone
- The instance Availability Zone. For more information, see Regions and Endpoints .ciTenancy
- 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 Overview and Amazon EC2 Dedicated Hosts . For more information about dedicated instances, see Dedicated Instances and Amazon EC2 Dedicated Instances .ciAutoScalingType
- For load-based or time-based instances, the type. Windows stacks can use only time-based instances.ciArchitecture
- The instance architecture. The default option isx86_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
- 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 .ciRootDeviceType
- The instance root device type. For more information, see Storage for the Root Device .ciBlockDeviceMappings
- An array ofBlockDeviceMapping
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.ciStackId
- The stack ID.ciLayerIds
- An array that contains the instance's layer IDs.ciInstanceType
- The instance type, such ast2.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.
data CreateInstance Source #
See: createInstance
smart constructor.
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.
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 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 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 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. Block device mappings are not supported if the value is Custom
. For more information on the supported operating systems, see Operating Systems For 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 .
ciTenancy :: Lens' CreateInstance (Maybe Text) Source #
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 .
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 .
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 . Note that block device mappings are not supported for custom AMIs.
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:
cirsInstanceId
- The instance ID.cirsResponseStatus
- -- | The response status code.
data CreateInstanceResponse Source #
Contains the response to a CreateInstance
request.
See: createInstanceResponse
smart constructor.
Response Lenses
cirsInstanceId :: Lens' CreateInstanceResponse (Maybe Text) Source #
The instance ID.
cirsResponseStatus :: Lens' CreateInstanceResponse Int Source #
- - | The response status code.