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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Modify the instance metadata parameters on a running or stopped instance. When you modify the parameters on a stopped instance, they are applied when the instance is started. When you modify the parameters on a running instance, the API responds with a state of “pending”. After the parameter modifications are successfully applied to the instance, the state of the modifications changes from “pending” to “applied” in subsequent describe-instances API calls. For more information, see Instance metadata and user data in the Amazon EC2 User Guide.

Synopsis

Creating a Request

data ModifyInstanceMetadataOptions Source #

See: newModifyInstanceMetadataOptions smart constructor.

Constructors

ModifyInstanceMetadataOptions'

Fields

dryRun :: Maybe Bool
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
httpEndpoint :: Maybe InstanceMetadataEndpointState
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 InstanceMetadataProtocolState
Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only if you have enabled the HTTP metadata endpoint.
httpPutResponseHopLimit :: Maybe Int
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. If no parameter is specified, the existing state is maintained.
Possible values: Integers from 1 to 64
httpTokens :: Maybe HttpTokensState
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 to retrieve instance metadata with or without a session token 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 using a valid session token, the version 2.0 role credentials are returned.
If the state is required, you must send a session token with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.
instanceMetadataTags :: Maybe InstanceMetadataTagsState
Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.
Default: disabled
instanceId :: Text
The ID of the instance.

Instances

Instances details

ToHeaders ModifyInstanceMetadataOptions Source #
Instance details Defined in Amazonka.EC2.ModifyInstanceMetadataOptions Methods toHeaders :: ModifyInstanceMetadataOptions -> [Header] #
ToPath ModifyInstanceMetadataOptions Source #
Instance details Defined in Amazonka.EC2.ModifyInstanceMetadataOptions Methods toPath :: ModifyInstanceMetadataOptions -> ByteString #
ToQuery ModifyInstanceMetadataOptions Source #
Instance details Defined in Amazonka.EC2.ModifyInstanceMetadataOptions Methods toQuery :: ModifyInstanceMetadataOptions -> QueryString #
AWSRequest ModifyInstanceMetadataOptions Source #
Instance details Defined in Amazonka.EC2.ModifyInstanceMetadataOptions Associated Types type AWSResponse ModifyInstanceMetadataOptions # Methods request :: (Service -> Service) -> ModifyInstanceMetadataOptions -> Request ModifyInstanceMetadataOptions # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ModifyInstanceMetadataOptions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ModifyInstanceMetadataOptions))) #
Generic ModifyInstanceMetadataOptions Source #
Instance details Defined in Amazonka.EC2.ModifyInstanceMetadataOptions Associated Types type Rep ModifyInstanceMetadataOptions :: Type -> Type # Methods from :: ModifyInstanceMetadataOptions -> Rep ModifyInstanceMetadataOptions x # to :: Rep ModifyInstanceMetadataOptions x -> ModifyInstanceMetadataOptions #
Read ModifyInstanceMetadataOptions Source #
Instance details Defined in Amazonka.EC2.ModifyInstanceMetadataOptions Methods readsPrec :: Int -> ReadS ModifyInstanceMetadataOptions # readList :: ReadS [ModifyInstanceMetadataOptions] # readPrec :: ReadPrec ModifyInstanceMetadataOptions # readListPrec :: ReadPrec [ModifyInstanceMetadataOptions] #
Show ModifyInstanceMetadataOptions Source #
Instance details Defined in Amazonka.EC2.ModifyInstanceMetadataOptions Methods showsPrec :: Int -> ModifyInstanceMetadataOptions -> ShowS # show :: ModifyInstanceMetadataOptions -> String # showList :: [ModifyInstanceMetadataOptions] -> ShowS #
NFData ModifyInstanceMetadataOptions Source #
Instance details Defined in Amazonka.EC2.ModifyInstanceMetadataOptions Methods rnf :: ModifyInstanceMetadataOptions -> () #
Eq ModifyInstanceMetadataOptions Source #
Instance details Defined in Amazonka.EC2.ModifyInstanceMetadataOptions Methods (==) :: ModifyInstanceMetadataOptions -> ModifyInstanceMetadataOptions -> Bool # (/=) :: ModifyInstanceMetadataOptions -> ModifyInstanceMetadataOptions -> Bool #
Hashable ModifyInstanceMetadataOptions Source #
Instance details Defined in Amazonka.EC2.ModifyInstanceMetadataOptions Methods hashWithSalt :: Int -> ModifyInstanceMetadataOptions -> Int # hash :: ModifyInstanceMetadataOptions -> Int #
type AWSResponse ModifyInstanceMetadataOptions Source #
Instance details Defined in Amazonka.EC2.ModifyInstanceMetadataOptions type AWSResponse ModifyInstanceMetadataOptions = ModifyInstanceMetadataOptionsResponse
type Rep ModifyInstanceMetadataOptions Source #
Instance details Defined in Amazonka.EC2.ModifyInstanceMetadataOptions type Rep ModifyInstanceMetadataOptions = D1 ('MetaData "ModifyInstanceMetadataOptions" "Amazonka.EC2.ModifyInstanceMetadataOptions" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "ModifyInstanceMetadataOptions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "httpEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceMetadataEndpointState)) :: S1 ('MetaSel ('Just "httpProtocolIpv6") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceMetadataProtocolState)))) :: ((S1 ('MetaSel ('Just "httpPutResponseHopLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "httpTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpTokensState))) :: (S1 ('MetaSel ('Just "instanceMetadataTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceMetadataTagsState)) :: S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newModifyInstanceMetadataOptions Source #

Arguments

:: Text	`ModifyInstanceMetadataOptions`
-> ModifyInstanceMetadataOptions

Create a value of ModifyInstanceMetadataOptions 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:dryRun:ModifyInstanceMetadataOptions', modifyInstanceMetadataOptions_dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

ModifyInstanceMetadataOptions, modifyInstanceMetadataOptions_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.

ModifyInstanceMetadataOptions, modifyInstanceMetadataOptions_httpProtocolIpv6 - Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only if you have enabled the HTTP metadata endpoint.

ModifyInstanceMetadataOptions, modifyInstanceMetadataOptions_httpPutResponseHopLimit - The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. If no parameter is specified, the existing state is maintained.

Possible values: Integers from 1 to 64

ModifyInstanceMetadataOptions, modifyInstanceMetadataOptions_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 to retrieve instance metadata with or without a session token 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 using a valid session token, the version 2.0 role credentials are returned.

If the state is required, you must send a session token with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.

ModifyInstanceMetadataOptions, modifyInstanceMetadataOptions_instanceMetadataTags - Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.

Default: disabled

ModifyInstanceMetadataOptions, modifyInstanceMetadataOptions_instanceId - The ID of the instance.

Request Lenses

modifyInstanceMetadataOptions_dryRun :: Lens' ModifyInstanceMetadataOptions (Maybe Bool) Source #

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

modifyInstanceMetadataOptions_httpEndpoint :: Lens' ModifyInstanceMetadataOptions (Maybe InstanceMetadataEndpointState) 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.

modifyInstanceMetadataOptions_httpProtocolIpv6 :: Lens' ModifyInstanceMetadataOptions (Maybe InstanceMetadataProtocolState) Source #

Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only if you have enabled the HTTP metadata endpoint.

modifyInstanceMetadataOptions_httpPutResponseHopLimit :: Lens' ModifyInstanceMetadataOptions (Maybe Int) Source #

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

Possible values: Integers from 1 to 64

modifyInstanceMetadataOptions_httpTokens :: Lens' ModifyInstanceMetadataOptions (Maybe HttpTokensState) 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 to retrieve instance metadata with or without a session token 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 using a valid session token, the version 2.0 role credentials are returned.

If the state is required, you must send a session token with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.

modifyInstanceMetadataOptions_instanceMetadataTags :: Lens' ModifyInstanceMetadataOptions (Maybe InstanceMetadataTagsState) Source #

Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.

Default: disabled

modifyInstanceMetadataOptions_instanceId :: Lens' ModifyInstanceMetadataOptions Text Source #

The ID of the instance.

Destructuring the Response

data ModifyInstanceMetadataOptionsResponse Source #

See: newModifyInstanceMetadataOptionsResponse smart constructor.

Constructors

ModifyInstanceMetadataOptionsResponse'
Fields instanceId :: Maybe Text The ID of the instance. instanceMetadataOptions :: Maybe InstanceMetadataOptionsResponse The metadata options for the instance. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ModifyInstanceMetadataOptionsResponse Source #
Instance details Defined in Amazonka.EC2.ModifyInstanceMetadataOptions Associated Types type Rep ModifyInstanceMetadataOptionsResponse :: Type -> Type # Methods from :: ModifyInstanceMetadataOptionsResponse -> Rep ModifyInstanceMetadataOptionsResponse x # to :: Rep ModifyInstanceMetadataOptionsResponse x -> ModifyInstanceMetadataOptionsResponse #
Read ModifyInstanceMetadataOptionsResponse Source #
Instance details Defined in Amazonka.EC2.ModifyInstanceMetadataOptions Methods readsPrec :: Int -> ReadS ModifyInstanceMetadataOptionsResponse # readList :: ReadS [ModifyInstanceMetadataOptionsResponse] # readPrec :: ReadPrec ModifyInstanceMetadataOptionsResponse # readListPrec :: ReadPrec [ModifyInstanceMetadataOptionsResponse] #
Show ModifyInstanceMetadataOptionsResponse Source #
Instance details Defined in Amazonka.EC2.ModifyInstanceMetadataOptions Methods showsPrec :: Int -> ModifyInstanceMetadataOptionsResponse -> ShowS # show :: ModifyInstanceMetadataOptionsResponse -> String # showList :: [ModifyInstanceMetadataOptionsResponse] -> ShowS #
NFData ModifyInstanceMetadataOptionsResponse Source #
Instance details Defined in Amazonka.EC2.ModifyInstanceMetadataOptions Methods rnf :: ModifyInstanceMetadataOptionsResponse -> () #
Eq ModifyInstanceMetadataOptionsResponse Source #
Instance details Defined in Amazonka.EC2.ModifyInstanceMetadataOptions Methods (==) :: ModifyInstanceMetadataOptionsResponse -> ModifyInstanceMetadataOptionsResponse -> Bool # (/=) :: ModifyInstanceMetadataOptionsResponse -> ModifyInstanceMetadataOptionsResponse -> Bool #
type Rep ModifyInstanceMetadataOptionsResponse Source #
Instance details Defined in Amazonka.EC2.ModifyInstanceMetadataOptions type Rep ModifyInstanceMetadataOptionsResponse = D1 ('MetaData "ModifyInstanceMetadataOptionsResponse" "Amazonka.EC2.ModifyInstanceMetadataOptions" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "ModifyInstanceMetadataOptionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "instanceMetadataOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceMetadataOptionsResponse)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newModifyInstanceMetadataOptionsResponse Source #

Arguments

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

Create a value of ModifyInstanceMetadataOptionsResponse 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:

ModifyInstanceMetadataOptions, modifyInstanceMetadataOptionsResponse_instanceId - The ID of the instance.

$sel:instanceMetadataOptions:ModifyInstanceMetadataOptionsResponse', modifyInstanceMetadataOptionsResponse_instanceMetadataOptions - The metadata options for the instance.

$sel:httpStatus:ModifyInstanceMetadataOptionsResponse', modifyInstanceMetadataOptionsResponse_httpStatus - The response's http status code.

Response Lenses

modifyInstanceMetadataOptionsResponse_instanceId :: Lens' ModifyInstanceMetadataOptionsResponse (Maybe Text) Source #

The ID of the instance.

modifyInstanceMetadataOptionsResponse_instanceMetadataOptions :: Lens' ModifyInstanceMetadataOptionsResponse (Maybe InstanceMetadataOptionsResponse) Source #

The metadata options for the instance.

modifyInstanceMetadataOptionsResponse_httpStatus :: Lens' ModifyInstanceMetadataOptionsResponse Int Source #

The response's http status code.