Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.ImageBuilder.Types.InstanceMetadataOptions

Description

Documentation

data InstanceMetadataOptions Source #

The instance metadata options that apply to the HTTP requests that pipeline builds use to launch EC2 build and test instances. For more information about instance metadata options, see Configure the instance metadata options in the /Amazon EC2 User Guide/ for Linux instances, or Configure the instance metadata options in the /Amazon EC2 Windows Guide/ for Windows instances.

See: newInstanceMetadataOptions smart constructor.

Constructors

InstanceMetadataOptions'

Fields

httpPutResponseHopLimit :: Maybe Natural
Limit the number of hops that an instance metadata request can traverse to reach its destination.
httpTokens :: Maybe Text
Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows:
- required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all cases.
- optional – You can include a signed token header in your request to retrieve instance metadata, or you can leave it out. If you include it, version 2.0 credentials are returned for the IAM role. Otherwise, version 1.0 credentials are returned.
The default setting is optional.

Instances

Instances details

Eq InstanceMetadataOptions Source #
Instance details Defined in Amazonka.ImageBuilder.Types.InstanceMetadataOptions Methods (==) :: InstanceMetadataOptions -> InstanceMetadataOptions -> Bool # (/=) :: InstanceMetadataOptions -> InstanceMetadataOptions -> Bool #
Read InstanceMetadataOptions Source #
Instance details Defined in Amazonka.ImageBuilder.Types.InstanceMetadataOptions Methods readsPrec :: Int -> ReadS InstanceMetadataOptions # readList :: ReadS [InstanceMetadataOptions] # readPrec :: ReadPrec InstanceMetadataOptions # readListPrec :: ReadPrec [InstanceMetadataOptions] #
Show InstanceMetadataOptions Source #
Instance details Defined in Amazonka.ImageBuilder.Types.InstanceMetadataOptions Methods showsPrec :: Int -> InstanceMetadataOptions -> ShowS # show :: InstanceMetadataOptions -> String # showList :: [InstanceMetadataOptions] -> ShowS #
Generic InstanceMetadataOptions Source #
Instance details Defined in Amazonka.ImageBuilder.Types.InstanceMetadataOptions Associated Types type Rep InstanceMetadataOptions :: Type -> Type # Methods from :: InstanceMetadataOptions -> Rep InstanceMetadataOptions x # to :: Rep InstanceMetadataOptions x -> InstanceMetadataOptions #
NFData InstanceMetadataOptions Source #
Instance details Defined in Amazonka.ImageBuilder.Types.InstanceMetadataOptions Methods rnf :: InstanceMetadataOptions -> () #
Hashable InstanceMetadataOptions Source #
Instance details Defined in Amazonka.ImageBuilder.Types.InstanceMetadataOptions Methods hashWithSalt :: Int -> InstanceMetadataOptions -> Int # hash :: InstanceMetadataOptions -> Int #
ToJSON InstanceMetadataOptions Source #
Instance details Defined in Amazonka.ImageBuilder.Types.InstanceMetadataOptions Methods toJSON :: InstanceMetadataOptions -> Value # toEncoding :: InstanceMetadataOptions -> Encoding # toJSONList :: [InstanceMetadataOptions] -> Value # toEncodingList :: [InstanceMetadataOptions] -> Encoding #
FromJSON InstanceMetadataOptions Source #
Instance details Defined in Amazonka.ImageBuilder.Types.InstanceMetadataOptions Methods parseJSON :: Value -> Parser InstanceMetadataOptions # parseJSONList :: Value -> Parser [InstanceMetadataOptions] #
type Rep InstanceMetadataOptions Source #
Instance details Defined in Amazonka.ImageBuilder.Types.InstanceMetadataOptions type Rep InstanceMetadataOptions = D1 ('MetaData "InstanceMetadataOptions" "Amazonka.ImageBuilder.Types.InstanceMetadataOptions" "libZSservicesZSamazonka-imagebuilderZSamazonka-imagebuilder" 'False) (C1 ('MetaCons "InstanceMetadataOptions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpPutResponseHopLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "httpTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newInstanceMetadataOptions :: InstanceMetadataOptions Source #

Create a value of InstanceMetadataOptions 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:httpPutResponseHopLimit:InstanceMetadataOptions', instanceMetadataOptions_httpPutResponseHopLimit - Limit the number of hops that an instance metadata request can traverse to reach its destination.

$sel:httpTokens:InstanceMetadataOptions', instanceMetadataOptions_httpTokens - Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows:

required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all cases.
optional – You can include a signed token header in your request to retrieve instance metadata, or you can leave it out. If you include it, version 2.0 credentials are returned for the IAM role. Otherwise, version 1.0 credentials are returned.

The default setting is optional.

instanceMetadataOptions_httpPutResponseHopLimit :: Lens' InstanceMetadataOptions (Maybe Natural) Source #

Limit the number of hops that an instance metadata request can traverse to reach its destination.

instanceMetadataOptions_httpTokens :: Lens' InstanceMetadataOptions (Maybe Text) Source #

Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows:

required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all cases.
optional – You can include a signed token header in your request to retrieve instance metadata, or you can leave it out. If you include it, version 2.0 credentials are returned for the IAM role. Otherwise, version 1.0 credentials are returned.

The default setting is optional.