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

Description

Synopsis

Documentation

data LaunchTemplateInstanceMetadataOptions Source #

The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon Elastic Compute Cloud User Guide.

See: newLaunchTemplateInstanceMetadataOptions smart constructor.

Constructors

LaunchTemplateInstanceMetadataOptions'

Fields

httpEndpoint :: Maybe LaunchTemplateInstanceMetadataEndpointState
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.
httpProtocolIpv6 :: Maybe LaunchTemplateInstanceMetadataProtocolIpv6
Enables or disables the IPv6 endpoint for the instance metadata service.
Default: 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 LaunchTemplateHttpTokensState
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.
instanceMetadataTags :: Maybe LaunchTemplateInstanceMetadataTagsState
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
state :: Maybe LaunchTemplateInstanceMetadataOptionsState
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

Instances details

FromXML LaunchTemplateInstanceMetadataOptions Source #
Instance details Defined in Amazonka.EC2.Types.LaunchTemplateInstanceMetadataOptions Methods parseXML :: [Node] -> Either String LaunchTemplateInstanceMetadataOptions #
Generic LaunchTemplateInstanceMetadataOptions Source #
Instance details Defined in Amazonka.EC2.Types.LaunchTemplateInstanceMetadataOptions Associated Types type Rep LaunchTemplateInstanceMetadataOptions :: Type -> Type # Methods from :: LaunchTemplateInstanceMetadataOptions -> Rep LaunchTemplateInstanceMetadataOptions x # to :: Rep LaunchTemplateInstanceMetadataOptions x -> LaunchTemplateInstanceMetadataOptions #
Read LaunchTemplateInstanceMetadataOptions Source #
Instance details Defined in Amazonka.EC2.Types.LaunchTemplateInstanceMetadataOptions Methods readsPrec :: Int -> ReadS LaunchTemplateInstanceMetadataOptions # readList :: ReadS [LaunchTemplateInstanceMetadataOptions] # readPrec :: ReadPrec LaunchTemplateInstanceMetadataOptions # readListPrec :: ReadPrec [LaunchTemplateInstanceMetadataOptions] #
Show LaunchTemplateInstanceMetadataOptions Source #
Instance details Defined in Amazonka.EC2.Types.LaunchTemplateInstanceMetadataOptions Methods showsPrec :: Int -> LaunchTemplateInstanceMetadataOptions -> ShowS # show :: LaunchTemplateInstanceMetadataOptions -> String # showList :: [LaunchTemplateInstanceMetadataOptions] -> ShowS #
NFData LaunchTemplateInstanceMetadataOptions Source #
Instance details Defined in Amazonka.EC2.Types.LaunchTemplateInstanceMetadataOptions Methods rnf :: LaunchTemplateInstanceMetadataOptions -> () #
Eq LaunchTemplateInstanceMetadataOptions Source #
Instance details Defined in Amazonka.EC2.Types.LaunchTemplateInstanceMetadataOptions Methods (==) :: LaunchTemplateInstanceMetadataOptions -> LaunchTemplateInstanceMetadataOptions -> Bool # (/=) :: LaunchTemplateInstanceMetadataOptions -> LaunchTemplateInstanceMetadataOptions -> Bool #
Hashable LaunchTemplateInstanceMetadataOptions Source #
Instance details Defined in Amazonka.EC2.Types.LaunchTemplateInstanceMetadataOptions Methods hashWithSalt :: Int -> LaunchTemplateInstanceMetadataOptions -> Int # hash :: LaunchTemplateInstanceMetadataOptions -> Int #
type Rep LaunchTemplateInstanceMetadataOptions Source #
Instance details Defined in Amazonka.EC2.Types.LaunchTemplateInstanceMetadataOptions type Rep LaunchTemplateInstanceMetadataOptions = D1 ('MetaData "LaunchTemplateInstanceMetadataOptions" "Amazonka.EC2.Types.LaunchTemplateInstanceMetadataOptions" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "LaunchTemplateInstanceMetadataOptions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LaunchTemplateInstanceMetadataEndpointState)) :: (S1 ('MetaSel ('Just "httpProtocolIpv6") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LaunchTemplateInstanceMetadataProtocolIpv6)) :: S1 ('MetaSel ('Just "httpPutResponseHopLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: (S1 ('MetaSel ('Just "httpTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LaunchTemplateHttpTokensState)) :: (S1 ('MetaSel ('Just "instanceMetadataTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LaunchTemplateInstanceMetadataTagsState)) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LaunchTemplateInstanceMetadataOptionsState))))))

newLaunchTemplateInstanceMetadataOptions :: LaunchTemplateInstanceMetadataOptions Source #

Create a value of LaunchTemplateInstanceMetadataOptions 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:LaunchTemplateInstanceMetadataOptions', launchTemplateInstanceMetadataOptions_httpEndpoint - 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:httpProtocolIpv6:LaunchTemplateInstanceMetadataOptions', launchTemplateInstanceMetadataOptions_httpProtocolIpv6 - Enables or disables the IPv6 endpoint for the instance metadata service.

Default: disabled

$sel:httpPutResponseHopLimit:LaunchTemplateInstanceMetadataOptions', launchTemplateInstanceMetadataOptions_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:LaunchTemplateInstanceMetadataOptions', launchTemplateInstanceMetadataOptions_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.

$sel:instanceMetadataTags:LaunchTemplateInstanceMetadataOptions', launchTemplateInstanceMetadataOptions_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

$sel:state:LaunchTemplateInstanceMetadataOptions', launchTemplateInstanceMetadataOptions_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.

launchTemplateInstanceMetadataOptions_httpEndpoint :: Lens' LaunchTemplateInstanceMetadataOptions (Maybe LaunchTemplateInstanceMetadataEndpointState) Source #

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.

launchTemplateInstanceMetadataOptions_httpProtocolIpv6 :: Lens' LaunchTemplateInstanceMetadataOptions (Maybe LaunchTemplateInstanceMetadataProtocolIpv6) Source #

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

Default: disabled

launchTemplateInstanceMetadataOptions_httpPutResponseHopLimit :: Lens' LaunchTemplateInstanceMetadataOptions (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.

Default: 1

Possible values: Integers from 1 to 64

launchTemplateInstanceMetadataOptions_httpTokens :: Lens' LaunchTemplateInstanceMetadataOptions (Maybe LaunchTemplateHttpTokensState) 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.

launchTemplateInstanceMetadataOptions_instanceMetadataTags :: Lens' LaunchTemplateInstanceMetadataOptions (Maybe LaunchTemplateInstanceMetadataTagsState) 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

launchTemplateInstanceMetadataOptions_state :: Lens' LaunchTemplateInstanceMetadataOptions (Maybe LaunchTemplateInstanceMetadataOptionsState) Source #

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.