libZSservicesZSamazonka-autoscalingZSamazonka-autoscaling
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.AutoScaling.Types.InstanceMetadataOptions

Description

 
Synopsis

Documentation

data InstanceMetadataOptions Source #

The metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the Amazon EC2 Auto Scaling User Guide.

See: newInstanceMetadataOptions smart constructor.

Constructors

InstanceMetadataOptions' 

Fields

  • httpEndpoint :: Maybe InstanceMetadataEndpointState

    This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.

    If you specify a value of disabled, you will not be able to access your instance metadata.

  • httpPutResponseHopLimit :: Maybe Natural

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

    Default: 1

  • httpTokens :: Maybe InstanceMetadataHttpTokensState

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

Instances

Instances details
Eq InstanceMetadataOptions Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.InstanceMetadataOptions

Read InstanceMetadataOptions Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.InstanceMetadataOptions

Show InstanceMetadataOptions Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.InstanceMetadataOptions

Generic InstanceMetadataOptions Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.InstanceMetadataOptions

Associated Types

type Rep InstanceMetadataOptions :: Type -> Type #

NFData InstanceMetadataOptions Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.InstanceMetadataOptions

Methods

rnf :: InstanceMetadataOptions -> () #

Hashable InstanceMetadataOptions Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.InstanceMetadataOptions

ToQuery InstanceMetadataOptions Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.InstanceMetadataOptions

FromXML InstanceMetadataOptions Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.InstanceMetadataOptions

type Rep InstanceMetadataOptions Source # 
Instance details

Defined in Amazonka.AutoScaling.Types.InstanceMetadataOptions

type Rep InstanceMetadataOptions = D1 ('MetaData "InstanceMetadataOptions" "Amazonka.AutoScaling.Types.InstanceMetadataOptions" "libZSservicesZSamazonka-autoscalingZSamazonka-autoscaling" 'False) (C1 ('MetaCons "InstanceMetadataOptions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceMetadataEndpointState)) :*: (S1 ('MetaSel ('Just "httpPutResponseHopLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "httpTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceMetadataHttpTokensState)))))

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:httpEndpoint:InstanceMetadataOptions', instanceMetadataOptions_httpEndpoint - This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.

If you specify a value of disabled, you will not be able to access your instance metadata.

$sel:httpPutResponseHopLimit:InstanceMetadataOptions', instanceMetadataOptions_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

$sel:httpTokens:InstanceMetadataOptions', instanceMetadataOptions_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 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 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 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.

instanceMetadataOptions_httpEndpoint :: Lens' InstanceMetadataOptions (Maybe InstanceMetadataEndpointState) Source #

This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.

If you specify a value of disabled, you will not be able to access your instance metadata.

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

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

Default: 1

instanceMetadataOptions_httpTokens :: Lens' InstanceMetadataOptions (Maybe InstanceMetadataHttpTokensState) 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 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 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 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.