Amazonka.EC2.Types.InstanceMetadataOptionsRequest

Documentation

data InstanceMetadataOptionsRequest

The metadata options for the instance.

See: newInstanceMetadataOptionsRequest smart constructor.

Constructors

InstanceMetadataOptionsRequest'

Fields

• httpEndpoint :: Maybe InstanceMetadataEndpointState

  Enables or disables the HTTP metadata endpoint on your instances.

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

  Default: enabled

• httpProtocolIpv6 :: Maybe InstanceMetadataProtocolState

  Enables or disables the IPv6 endpoint for the instance metadata service.

• 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.

  Default: 1

  Possible values: Integers from 1 to 64

• httpTokens :: Maybe HttpTokensState

  The state of token usage for your instance metadata requests.

  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.

  Default: optional

• 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

Instances

ToQuery InstanceMetadataOptionsRequest

Defined in Amazonka.EC2.Types.InstanceMetadataOptionsRequest

Methods

toQuery :: InstanceMetadataOptionsRequest -> QueryString

Generic InstanceMetadataOptionsRequest

Defined in Amazonka.EC2.Types.InstanceMetadataOptionsRequest

Associated Types

type Rep InstanceMetadataOptionsRequest :: Type -> Type

Methods

from :: InstanceMetadataOptionsRequest -> Rep InstanceMetadataOptionsRequest x

to :: Rep InstanceMetadataOptionsRequest x -> InstanceMetadataOptionsRequest

Read InstanceMetadataOptionsRequest

Defined in Amazonka.EC2.Types.InstanceMetadataOptionsRequest

Methods

readsPrec :: Int -> ReadS InstanceMetadataOptionsRequest

readList :: ReadS [InstanceMetadataOptionsRequest]

readPrec :: ReadPrec InstanceMetadataOptionsRequest

readListPrec :: ReadPrec [InstanceMetadataOptionsRequest]

Show InstanceMetadataOptionsRequest

Defined in Amazonka.EC2.Types.InstanceMetadataOptionsRequest

Methods

showsPrec :: Int -> InstanceMetadataOptionsRequest -> ShowS

show :: InstanceMetadataOptionsRequest -> String

showList :: [InstanceMetadataOptionsRequest] -> ShowS

NFData InstanceMetadataOptionsRequest

Defined in Amazonka.EC2.Types.InstanceMetadataOptionsRequest

Methods

rnf :: InstanceMetadataOptionsRequest -> ()

Eq InstanceMetadataOptionsRequest

Defined in Amazonka.EC2.Types.InstanceMetadataOptionsRequest

Methods

(==) :: InstanceMetadataOptionsRequest -> InstanceMetadataOptionsRequest -> Bool

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

Hashable InstanceMetadataOptionsRequest

Defined in Amazonka.EC2.Types.InstanceMetadataOptionsRequest

Methods

hashWithSalt :: Int -> InstanceMetadataOptionsRequest -> Int

hash :: InstanceMetadataOptionsRequest -> Int

type Rep InstanceMetadataOptionsRequest

Defined in Amazonka.EC2.Types.InstanceMetadataOptionsRequest

type Rep InstanceMetadataOptionsRequest = D1 ('MetaData "InstanceMetadataOptionsRequest" "Amazonka.EC2.Types.InstanceMetadataOptionsRequest" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "InstanceMetadataOptionsRequest'" 'PrefixI 'True) ((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))))))

newInstanceMetadataOptionsRequest :: InstanceMetadataOptionsRequest

Create a value of InstanceMetadataOptionsRequest 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:httpEndpoint:InstanceMetadataOptionsRequest', instanceMetadataOptionsRequest_httpEndpoint - Enables or disables the HTTP metadata endpoint on your instances.

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

Default: enabled

$sel:httpProtocolIpv6:InstanceMetadataOptionsRequest', instanceMetadataOptionsRequest_httpProtocolIpv6 - Enables or disables the IPv6 endpoint for the instance metadata service.

$sel:httpPutResponseHopLimit:InstanceMetadataOptionsRequest', instanceMetadataOptionsRequest_httpPutResponseHopLimit - The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.

Default: 1

Possible values: Integers from 1 to 64

$sel:httpTokens:InstanceMetadataOptionsRequest', instanceMetadataOptionsRequest_httpTokens - The state of token usage for your instance metadata requests.

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.

Default: optional

$sel:instanceMetadataTags:InstanceMetadataOptionsRequest', instanceMetadataOptionsRequest_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

instanceMetadataOptionsRequest_httpEndpoint :: Lens' InstanceMetadataOptionsRequest (Maybe InstanceMetadataEndpointState)

Enables or disables the HTTP metadata endpoint on your instances.

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

Default: enabled

instanceMetadataOptionsRequest_httpProtocolIpv6 :: Lens' InstanceMetadataOptionsRequest (Maybe InstanceMetadataProtocolState)

Enables or disables the IPv6 endpoint for the instance metadata service.

instanceMetadataOptionsRequest_httpPutResponseHopLimit :: Lens' InstanceMetadataOptionsRequest (Maybe Int)

The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.

Default: 1

Possible values: Integers from 1 to 64

instanceMetadataOptionsRequest_httpTokens :: Lens' InstanceMetadataOptionsRequest (Maybe HttpTokensState)

The state of token usage for your instance metadata requests.

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.

Default: optional

instanceMetadataOptionsRequest_instanceMetadataTags :: Lens' InstanceMetadataOptionsRequest (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