Network.AWS.OpsWorks.UpdateInstance

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 .

Creating a Request

updateInstance

Arguments

:: Text

uiInstanceId

-> UpdateInstance

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:

• uiInstallUpdatesOnBoot - 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.
• uiHostname - The instance host name.
• uiSSHKeyName - The instance's Amazon EC2 key name.
• uiAgentVersion - 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, you must 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.
• uiInstanceType - 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 - This property cannot be updated.
• uiOS - The instance's operating system, which must be set to one of the following. You cannot update an instance that is using a custom AMI. * A supported Linux operating system: An Amazon Linux version, such as 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 . For more information on 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 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 .
• uiAutoScalingType - For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
• uiLayerIds - The instance's layer IDs.
• uiArchitecture - 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 .
• uiAMIId - The ID of the AMI that was used to create the instance. The value of this parameter must be the same AMI ID that the instance is already using. You cannot apply a new AMI to an instance by running UpdateInstance. UpdateInstance does not work on instances that are using custom AMIs.
• uiInstanceId - The instance ID.

data UpdateInstance

See: updateInstance smart constructor.

Instances

Eq UpdateInstance

Methods

(==) :: UpdateInstance -> UpdateInstance -> Bool

(/=) :: UpdateInstance -> UpdateInstance -> Bool

Data UpdateInstance

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateInstance -> c UpdateInstance

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateInstance

toConstr :: UpdateInstance -> Constr

dataTypeOf :: UpdateInstance -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateInstance)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateInstance)

gmapT :: (forall b. Data b => b -> b) -> UpdateInstance -> UpdateInstance

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateInstance -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateInstance -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateInstance -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateInstance -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateInstance -> m UpdateInstance

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateInstance -> m UpdateInstance

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateInstance -> m UpdateInstance

Read UpdateInstance

Methods

readsPrec :: Int -> ReadS UpdateInstance

readList :: ReadS [UpdateInstance]

readPrec :: ReadPrec UpdateInstance

readListPrec :: ReadPrec [UpdateInstance]

Show UpdateInstance

Methods

showsPrec :: Int -> UpdateInstance -> ShowS

show :: UpdateInstance -> String

showList :: [UpdateInstance] -> ShowS

Generic UpdateInstance

Associated Types

type Rep UpdateInstance :: * -> *

Methods

from :: UpdateInstance -> Rep UpdateInstance x

to :: Rep UpdateInstance x -> UpdateInstance

Hashable UpdateInstance

Methods

hashWithSalt :: Int -> UpdateInstance -> Int

hash :: UpdateInstance -> Int

ToJSON UpdateInstance

Methods

toJSON :: UpdateInstance -> Value

toEncoding :: UpdateInstance -> Encoding

toJSONList :: [UpdateInstance] -> Value

toEncodingList :: [UpdateInstance] -> Encoding

NFData UpdateInstance

Methods

rnf :: UpdateInstance -> ()

AWSRequest UpdateInstance

Associated Types

type Rs UpdateInstance :: *

Methods

request :: UpdateInstance -> Request UpdateInstance

response :: MonadResource m => Logger -> Service -> Proxy * UpdateInstance -> ClientResponse -> m (Response UpdateInstance)

ToQuery UpdateInstance

Methods

toQuery :: UpdateInstance -> QueryString

ToPath UpdateInstance

Methods

toPath :: UpdateInstance -> ByteString

ToHeaders UpdateInstance

Methods

toHeaders :: UpdateInstance -> [Header]

type Rep UpdateInstance

type Rep UpdateInstance = D1 (MetaData "UpdateInstance" "Network.AWS.OpsWorks.UpdateInstance" "amazonka-opsworks-1.5.0-9Cz7dbg1Tt8zDXFeRwqsG" False) (C1 (MetaCons "UpdateInstance'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_uiInstallUpdatesOnBoot") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "_uiHostname") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_uiSSHKeyName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_uiAgentVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_uiInstanceType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_uiEBSOptimized") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_uiOS") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_uiAutoScalingType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe AutoScalingType))) (S1 (MetaSel (Just Symbol "_uiLayerIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))))) ((:*:) (S1 (MetaSel (Just Symbol "_uiArchitecture") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Architecture))) ((:*:) (S1 (MetaSel (Just Symbol "_uiAMIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_uiInstanceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))))

type Rs UpdateInstance

type Rs UpdateInstance = UpdateInstanceResponse

Request Lenses

uiInstallUpdatesOnBoot :: Lens' UpdateInstance (Maybe 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.

uiHostname :: Lens' UpdateInstance (Maybe Text)

The instance host name.

uiSSHKeyName :: Lens' UpdateInstance (Maybe Text)

The instance's Amazon EC2 key name.

uiAgentVersion :: Lens' UpdateInstance (Maybe Text)

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, you must 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.

uiInstanceType :: Lens' UpdateInstance (Maybe Text)

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)

This property cannot be updated.

uiOS :: Lens' UpdateInstance (Maybe Text)

The instance's operating system, which must be set to one of the following. You cannot update an instance that is using a custom AMI. * A supported Linux operating system: An Amazon Linux version, such as 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 . For more information on 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 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 .

uiAutoScalingType :: Lens' UpdateInstance (Maybe AutoScalingType)

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

uiLayerIds :: Lens' UpdateInstance [Text]

The instance's layer IDs.

uiArchitecture :: Lens' UpdateInstance (Maybe Architecture)

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 .

uiAMIId :: Lens' UpdateInstance (Maybe Text)

The ID of the AMI that was used to create the instance. The value of this parameter must be the same AMI ID that the instance is already using. You cannot apply a new AMI to an instance by running UpdateInstance. UpdateInstance does not work on instances that are using custom AMIs.

uiInstanceId :: Lens' UpdateInstance Text

The instance ID.

Destructuring the Response

updateInstanceResponse :: UpdateInstanceResponse

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

data UpdateInstanceResponse

See: updateInstanceResponse smart constructor.

Instances

Eq UpdateInstanceResponse

Methods

(==) :: UpdateInstanceResponse -> UpdateInstanceResponse -> Bool

(/=) :: UpdateInstanceResponse -> UpdateInstanceResponse -> Bool

Data UpdateInstanceResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateInstanceResponse -> c UpdateInstanceResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateInstanceResponse

toConstr :: UpdateInstanceResponse -> Constr

dataTypeOf :: UpdateInstanceResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateInstanceResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateInstanceResponse)

gmapT :: (forall b. Data b => b -> b) -> UpdateInstanceResponse -> UpdateInstanceResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateInstanceResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateInstanceResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateInstanceResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateInstanceResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateInstanceResponse -> m UpdateInstanceResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateInstanceResponse -> m UpdateInstanceResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateInstanceResponse -> m UpdateInstanceResponse

Read UpdateInstanceResponse

Methods

readsPrec :: Int -> ReadS UpdateInstanceResponse

readList :: ReadS [UpdateInstanceResponse]

readPrec :: ReadPrec UpdateInstanceResponse

readListPrec :: ReadPrec [UpdateInstanceResponse]

Show UpdateInstanceResponse

Methods

showsPrec :: Int -> UpdateInstanceResponse -> ShowS

show :: UpdateInstanceResponse -> String

showList :: [UpdateInstanceResponse] -> ShowS

Generic UpdateInstanceResponse

Associated Types

type Rep UpdateInstanceResponse :: * -> *

Methods

from :: UpdateInstanceResponse -> Rep UpdateInstanceResponse x

to :: Rep UpdateInstanceResponse x -> UpdateInstanceResponse

NFData UpdateInstanceResponse

Methods

rnf :: UpdateInstanceResponse -> ()

type Rep UpdateInstanceResponse

type Rep UpdateInstanceResponse = D1 (MetaData "UpdateInstanceResponse" "Network.AWS.OpsWorks.UpdateInstance" "amazonka-opsworks-1.5.0-9Cz7dbg1Tt8zDXFeRwqsG" False) (C1 (MetaCons "UpdateInstanceResponse'" PrefixI False) U1)