Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Lightsail.UpdateInstanceMetadataOptions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Modifies the Amazon Lightsail instance metadata parameters on a running or stopped instance. When you modify the parameters on a running instance, the GetInstance or GetInstances API operation initially responds with a state of pending. After the parameter modifications are successfully applied, the state changes to applied in subsequent GetInstance or GetInstances API calls. For more information, see Use IMDSv2 with an Amazon Lightsail instance in the Amazon Lightsail Developer Guide.

Synopsis

Creating a Request

data UpdateInstanceMetadataOptions Source #

See: newUpdateInstanceMetadataOptions smart constructor.

Constructors

UpdateInstanceMetadataOptions'

Fields

httpEndpoint :: Maybe HttpEndpoint
Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.
If you specify a value of disabled, you cannot access your instance metadata.
httpProtocolIpv6 :: Maybe HttpProtocolIpv6
Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only when the HTTP metadata endpoint is enabled.
This parameter is available only for instances in the Europe (Stockholm) Amazon Web Services Region (eu-north-1).
httpPutResponseHopLimit :: Maybe Int
The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther. If no parameter is specified, the existing state is maintained.
httpTokens :: Maybe HttpTokens
The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.
If the state is optional, you can choose whether to retrieve instance metadata with a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the version 2.0 role credentials are returned.
If the state is required, you must send a signed token header with all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.
instanceName :: Text
The name of the instance for which to update metadata parameters.

Instances

Instances details

ToJSON UpdateInstanceMetadataOptions Source #
Instance details Defined in Amazonka.Lightsail.UpdateInstanceMetadataOptions Methods toJSON :: UpdateInstanceMetadataOptions -> Value # toEncoding :: UpdateInstanceMetadataOptions -> Encoding # toJSONList :: [UpdateInstanceMetadataOptions] -> Value # toEncodingList :: [UpdateInstanceMetadataOptions] -> Encoding #
ToHeaders UpdateInstanceMetadataOptions Source #
Instance details Defined in Amazonka.Lightsail.UpdateInstanceMetadataOptions Methods toHeaders :: UpdateInstanceMetadataOptions -> [Header] #
ToPath UpdateInstanceMetadataOptions Source #
Instance details Defined in Amazonka.Lightsail.UpdateInstanceMetadataOptions Methods toPath :: UpdateInstanceMetadataOptions -> ByteString #
ToQuery UpdateInstanceMetadataOptions Source #
Instance details Defined in Amazonka.Lightsail.UpdateInstanceMetadataOptions Methods toQuery :: UpdateInstanceMetadataOptions -> QueryString #
AWSRequest UpdateInstanceMetadataOptions Source #
Instance details Defined in Amazonka.Lightsail.UpdateInstanceMetadataOptions Associated Types type AWSResponse UpdateInstanceMetadataOptions # Methods request :: (Service -> Service) -> UpdateInstanceMetadataOptions -> Request UpdateInstanceMetadataOptions # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateInstanceMetadataOptions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateInstanceMetadataOptions))) #
Generic UpdateInstanceMetadataOptions Source #
Instance details Defined in Amazonka.Lightsail.UpdateInstanceMetadataOptions Associated Types type Rep UpdateInstanceMetadataOptions :: Type -> Type # Methods from :: UpdateInstanceMetadataOptions -> Rep UpdateInstanceMetadataOptions x # to :: Rep UpdateInstanceMetadataOptions x -> UpdateInstanceMetadataOptions #
Read UpdateInstanceMetadataOptions Source #
Instance details Defined in Amazonka.Lightsail.UpdateInstanceMetadataOptions Methods readsPrec :: Int -> ReadS UpdateInstanceMetadataOptions # readList :: ReadS [UpdateInstanceMetadataOptions] # readPrec :: ReadPrec UpdateInstanceMetadataOptions # readListPrec :: ReadPrec [UpdateInstanceMetadataOptions] #
Show UpdateInstanceMetadataOptions Source #
Instance details Defined in Amazonka.Lightsail.UpdateInstanceMetadataOptions Methods showsPrec :: Int -> UpdateInstanceMetadataOptions -> ShowS # show :: UpdateInstanceMetadataOptions -> String # showList :: [UpdateInstanceMetadataOptions] -> ShowS #
NFData UpdateInstanceMetadataOptions Source #
Instance details Defined in Amazonka.Lightsail.UpdateInstanceMetadataOptions Methods rnf :: UpdateInstanceMetadataOptions -> () #
Eq UpdateInstanceMetadataOptions Source #
Instance details Defined in Amazonka.Lightsail.UpdateInstanceMetadataOptions Methods (==) :: UpdateInstanceMetadataOptions -> UpdateInstanceMetadataOptions -> Bool # (/=) :: UpdateInstanceMetadataOptions -> UpdateInstanceMetadataOptions -> Bool #
Hashable UpdateInstanceMetadataOptions Source #
Instance details Defined in Amazonka.Lightsail.UpdateInstanceMetadataOptions Methods hashWithSalt :: Int -> UpdateInstanceMetadataOptions -> Int # hash :: UpdateInstanceMetadataOptions -> Int #
type AWSResponse UpdateInstanceMetadataOptions Source #
Instance details Defined in Amazonka.Lightsail.UpdateInstanceMetadataOptions type AWSResponse UpdateInstanceMetadataOptions = UpdateInstanceMetadataOptionsResponse
type Rep UpdateInstanceMetadataOptions Source #
Instance details Defined in Amazonka.Lightsail.UpdateInstanceMetadataOptions type Rep UpdateInstanceMetadataOptions = D1 ('MetaData "UpdateInstanceMetadataOptions" "Amazonka.Lightsail.UpdateInstanceMetadataOptions" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "UpdateInstanceMetadataOptions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpEndpoint)) :: S1 ('MetaSel ('Just "httpProtocolIpv6") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpProtocolIpv6))) :: (S1 ('MetaSel ('Just "httpPutResponseHopLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "httpTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpTokens)) :: S1 ('MetaSel ('Just "instanceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateInstanceMetadataOptions Source #

Arguments

:: Text	`UpdateInstanceMetadataOptions`
-> UpdateInstanceMetadataOptions

Create a value of UpdateInstanceMetadataOptions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateInstanceMetadataOptions, updateInstanceMetadataOptions_httpEndpoint - Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.

If you specify a value of disabled, you cannot access your instance metadata.

UpdateInstanceMetadataOptions, updateInstanceMetadataOptions_httpProtocolIpv6 - Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only when the HTTP metadata endpoint is enabled.

This parameter is available only for instances in the Europe (Stockholm) Amazon Web Services Region (eu-north-1).

UpdateInstanceMetadataOptions, updateInstanceMetadataOptions_httpPutResponseHopLimit - The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther. If no parameter is specified, the existing state is maintained.

UpdateInstanceMetadataOptions, updateInstanceMetadataOptions_httpTokens - The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.

If the state is optional, you can choose whether to retrieve instance metadata with a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the version 2.0 role credentials are returned.

If the state is required, you must send a signed token header with all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.

UpdateInstanceMetadataOptions, updateInstanceMetadataOptions_instanceName - The name of the instance for which to update metadata parameters.

Request Lenses

updateInstanceMetadataOptions_httpEndpoint :: Lens' UpdateInstanceMetadataOptions (Maybe HttpEndpoint) Source #

Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.

If you specify a value of disabled, you cannot access your instance metadata.

updateInstanceMetadataOptions_httpProtocolIpv6 :: Lens' UpdateInstanceMetadataOptions (Maybe HttpProtocolIpv6) Source #

Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only when the HTTP metadata endpoint is enabled.

This parameter is available only for instances in the Europe (Stockholm) Amazon Web Services Region (eu-north-1).

updateInstanceMetadataOptions_httpPutResponseHopLimit :: Lens' UpdateInstanceMetadataOptions (Maybe Int) Source #

The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther. If no parameter is specified, the existing state is maintained.

updateInstanceMetadataOptions_httpTokens :: Lens' UpdateInstanceMetadataOptions (Maybe HttpTokens) Source #

The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.

If the state is optional, you can choose whether to retrieve instance metadata with a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the version 2.0 role credentials are returned.

If the state is required, you must send a signed token header with all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.

updateInstanceMetadataOptions_instanceName :: Lens' UpdateInstanceMetadataOptions Text Source #

The name of the instance for which to update metadata parameters.

Destructuring the Response

data UpdateInstanceMetadataOptionsResponse Source #

See: newUpdateInstanceMetadataOptionsResponse smart constructor.

Constructors

UpdateInstanceMetadataOptionsResponse'
Fields operation :: Maybe Operation httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateInstanceMetadataOptionsResponse Source #
Instance details Defined in Amazonka.Lightsail.UpdateInstanceMetadataOptions Associated Types type Rep UpdateInstanceMetadataOptionsResponse :: Type -> Type # Methods from :: UpdateInstanceMetadataOptionsResponse -> Rep UpdateInstanceMetadataOptionsResponse x # to :: Rep UpdateInstanceMetadataOptionsResponse x -> UpdateInstanceMetadataOptionsResponse #
Read UpdateInstanceMetadataOptionsResponse Source #
Instance details Defined in Amazonka.Lightsail.UpdateInstanceMetadataOptions Methods readsPrec :: Int -> ReadS UpdateInstanceMetadataOptionsResponse # readList :: ReadS [UpdateInstanceMetadataOptionsResponse] # readPrec :: ReadPrec UpdateInstanceMetadataOptionsResponse # readListPrec :: ReadPrec [UpdateInstanceMetadataOptionsResponse] #
Show UpdateInstanceMetadataOptionsResponse Source #
Instance details Defined in Amazonka.Lightsail.UpdateInstanceMetadataOptions Methods showsPrec :: Int -> UpdateInstanceMetadataOptionsResponse -> ShowS # show :: UpdateInstanceMetadataOptionsResponse -> String # showList :: [UpdateInstanceMetadataOptionsResponse] -> ShowS #
NFData UpdateInstanceMetadataOptionsResponse Source #
Instance details Defined in Amazonka.Lightsail.UpdateInstanceMetadataOptions Methods rnf :: UpdateInstanceMetadataOptionsResponse -> () #
Eq UpdateInstanceMetadataOptionsResponse Source #
Instance details Defined in Amazonka.Lightsail.UpdateInstanceMetadataOptions Methods (==) :: UpdateInstanceMetadataOptionsResponse -> UpdateInstanceMetadataOptionsResponse -> Bool # (/=) :: UpdateInstanceMetadataOptionsResponse -> UpdateInstanceMetadataOptionsResponse -> Bool #
type Rep UpdateInstanceMetadataOptionsResponse Source #
Instance details Defined in Amazonka.Lightsail.UpdateInstanceMetadataOptions type Rep UpdateInstanceMetadataOptionsResponse = D1 ('MetaData "UpdateInstanceMetadataOptionsResponse" "Amazonka.Lightsail.UpdateInstanceMetadataOptions" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "UpdateInstanceMetadataOptionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "operation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Operation)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateInstanceMetadataOptionsResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateInstanceMetadataOptionsResponse'`
-> UpdateInstanceMetadataOptionsResponse

Create a value of UpdateInstanceMetadataOptionsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:operation:UpdateInstanceMetadataOptionsResponse', updateInstanceMetadataOptionsResponse_operation - Undocumented member.

$sel:httpStatus:UpdateInstanceMetadataOptionsResponse', updateInstanceMetadataOptionsResponse_httpStatus - The response's http status code.

Response Lenses

updateInstanceMetadataOptionsResponse_operation :: Lens' UpdateInstanceMetadataOptionsResponse (Maybe Operation) Source #

Undocumented member.

updateInstanceMetadataOptionsResponse_httpStatus :: Lens' UpdateInstanceMetadataOptionsResponse Int Source #

The response's http status code.