Amazonka.EC2.Types.InstanceMetadataOptionsResponse

Documentation

data InstanceMetadataOptionsResponse

The metadata options for the instance.

See: newInstanceMetadataOptionsResponse smart constructor.

Constructors

InstanceMetadataOptionsResponse'

Fields

• httpEndpoint :: Maybe InstanceMetadataEndpointState

  Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

  If the value is disabled, you cannot access your instance metadata.

• httpProtocolIpv6 :: Maybe InstanceMetadataProtocolState

  Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

• 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

  Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata.

• state :: Maybe InstanceMetadataOptionsState

  The state of the metadata option changes.

  pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.

  applied - The metadata options have been successfully applied on the instance.

Instances

FromXML InstanceMetadataOptionsResponse

Defined in Amazonka.EC2.Types.InstanceMetadataOptionsResponse

Methods

parseXML :: [Node] -> Either String InstanceMetadataOptionsResponse

Generic InstanceMetadataOptionsResponse

Defined in Amazonka.EC2.Types.InstanceMetadataOptionsResponse

Associated Types

type Rep InstanceMetadataOptionsResponse :: Type -> Type

Methods

from :: InstanceMetadataOptionsResponse -> Rep InstanceMetadataOptionsResponse x

to :: Rep InstanceMetadataOptionsResponse x -> InstanceMetadataOptionsResponse

Read InstanceMetadataOptionsResponse

Defined in Amazonka.EC2.Types.InstanceMetadataOptionsResponse

Methods

readsPrec :: Int -> ReadS InstanceMetadataOptionsResponse

readList :: ReadS [InstanceMetadataOptionsResponse]

readPrec :: ReadPrec InstanceMetadataOptionsResponse

readListPrec :: ReadPrec [InstanceMetadataOptionsResponse]

Show InstanceMetadataOptionsResponse

Defined in Amazonka.EC2.Types.InstanceMetadataOptionsResponse

Methods

showsPrec :: Int -> InstanceMetadataOptionsResponse -> ShowS

show :: InstanceMetadataOptionsResponse -> String

showList :: [InstanceMetadataOptionsResponse] -> ShowS

NFData InstanceMetadataOptionsResponse

Defined in Amazonka.EC2.Types.InstanceMetadataOptionsResponse

Methods

rnf :: InstanceMetadataOptionsResponse -> ()

Eq InstanceMetadataOptionsResponse

Defined in Amazonka.EC2.Types.InstanceMetadataOptionsResponse

Methods

(==) :: InstanceMetadataOptionsResponse -> InstanceMetadataOptionsResponse -> Bool

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

Hashable InstanceMetadataOptionsResponse

Defined in Amazonka.EC2.Types.InstanceMetadataOptionsResponse

Methods

hashWithSalt :: Int -> InstanceMetadataOptionsResponse -> Int

hash :: InstanceMetadataOptionsResponse -> Int

type Rep InstanceMetadataOptionsResponse

Defined in Amazonka.EC2.Types.InstanceMetadataOptionsResponse

type Rep InstanceMetadataOptionsResponse = D1 ('MetaData "InstanceMetadataOptionsResponse" "Amazonka.EC2.Types.InstanceMetadataOptionsResponse" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "InstanceMetadataOptionsResponse'" '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)) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceMetadataOptionsState))))))

newInstanceMetadataOptionsResponse :: InstanceMetadataOptionsResponse

Create a value of InstanceMetadataOptionsResponse 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:InstanceMetadataOptionsResponse', instanceMetadataOptionsResponse_httpEndpoint - Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

If the value is disabled, you cannot access your instance metadata.

$sel:httpProtocolIpv6:InstanceMetadataOptionsResponse', instanceMetadataOptionsResponse_httpProtocolIpv6 - Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

$sel:httpPutResponseHopLimit:InstanceMetadataOptionsResponse', instanceMetadataOptionsResponse_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:InstanceMetadataOptionsResponse', instanceMetadataOptionsResponse_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:InstanceMetadataOptionsResponse', instanceMetadataOptionsResponse_instanceMetadataTags - Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata.

$sel:state:InstanceMetadataOptionsResponse', instanceMetadataOptionsResponse_state - The state of the metadata option changes.

pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.

applied - The metadata options have been successfully applied on the instance.

instanceMetadataOptionsResponse_httpEndpoint :: Lens' InstanceMetadataOptionsResponse (Maybe InstanceMetadataEndpointState)

Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

If the value is disabled, you cannot access your instance metadata.

instanceMetadataOptionsResponse_httpProtocolIpv6 :: Lens' InstanceMetadataOptionsResponse (Maybe InstanceMetadataProtocolState)

Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

instanceMetadataOptionsResponse_httpPutResponseHopLimit :: Lens' InstanceMetadataOptionsResponse (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

instanceMetadataOptionsResponse_httpTokens :: Lens' InstanceMetadataOptionsResponse (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

instanceMetadataOptionsResponse_instanceMetadataTags :: Lens' InstanceMetadataOptionsResponse (Maybe InstanceMetadataTagsState)

Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata.

instanceMetadataOptionsResponse_state :: Lens' InstanceMetadataOptionsResponse (Maybe InstanceMetadataOptionsState)

The state of the metadata option changes.

pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.

applied - The metadata options have been successfully applied on the instance.