Copyright | (c) 2013-2015 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 |
Updates a specified instance.
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 UpdateInstance.
- updateInstance :: Text -> UpdateInstance
- data UpdateInstance
- uiInstallUpdatesOnBoot :: Lens' UpdateInstance (Maybe Bool)
- uiHostname :: Lens' UpdateInstance (Maybe Text)
- uiSSHKeyName :: Lens' UpdateInstance (Maybe Text)
- uiAgentVersion :: Lens' UpdateInstance (Maybe Text)
- uiInstanceType :: Lens' UpdateInstance (Maybe Text)
- uiEBSOptimized :: Lens' UpdateInstance (Maybe Bool)
- uiOS :: Lens' UpdateInstance (Maybe Text)
- uiAutoScalingType :: Lens' UpdateInstance (Maybe AutoScalingType)
- uiLayerIds :: Lens' UpdateInstance [Text]
- uiArchitecture :: Lens' UpdateInstance (Maybe Architecture)
- uiAMIId :: Lens' UpdateInstance (Maybe Text)
- uiInstanceId :: Lens' UpdateInstance Text
- updateInstanceResponse :: UpdateInstanceResponse
- data UpdateInstanceResponse
Creating a Request
Creates a value of UpdateInstance
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data UpdateInstance Source
See: updateInstance
smart constructor.
Request Lenses
uiInstallUpdatesOnBoot :: Lens' UpdateInstance (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.
uiHostname :: Lens' UpdateInstance (Maybe Text) Source
The instance host name.
uiSSHKeyName :: Lens' UpdateInstance (Maybe Text) Source
The instance's Amazon EC2 key name.
uiAgentVersion :: Lens' UpdateInstance (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, you must 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.
uiInstanceType :: Lens' UpdateInstance (Maybe 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.
uiEBSOptimized :: Lens' UpdateInstance (Maybe Bool) Source
This property cannot be updated.
uiOS :: Lens' UpdateInstance (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 AmiId parameter to specify the
custom AMI that you want to use. For more information on the supported
operating systems, see
Operating Systems.
For more information on how to use custom AMIs with OpsWorks, see
Using Custom AMIs.
You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux.
uiAutoScalingType :: Lens' UpdateInstance (Maybe AutoScalingType) Source
For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
uiLayerIds :: Lens' UpdateInstance [Text] Source
The instance's layer IDs.
uiArchitecture :: Lens' UpdateInstance (Maybe Architecture) Source
The instance architecture. 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.
uiInstanceId :: Lens' UpdateInstance Text Source
The instance ID.
Destructuring the Response
updateInstanceResponse :: UpdateInstanceResponse Source
Creates a value of UpdateInstanceResponse
with the minimum fields required to make a request.