{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE StrictData #-} {-# LANGUAGE NoImplicitPrelude #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Amazonka.EC2.Types.LaunchTemplateInstanceMetadataOptions -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) module Amazonka.EC2.Types.LaunchTemplateInstanceMetadataOptions where import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import Amazonka.EC2.Internal import Amazonka.EC2.Types.LaunchTemplateHttpTokensState import Amazonka.EC2.Types.LaunchTemplateInstanceMetadataEndpointState import Amazonka.EC2.Types.LaunchTemplateInstanceMetadataOptionsState import Amazonka.EC2.Types.LaunchTemplateInstanceMetadataProtocolIpv6 import Amazonka.EC2.Types.LaunchTemplateInstanceMetadataTagsState import qualified Amazonka.Prelude as Prelude -- | The metadata options for the instance. For more information, see -- -- in the /Amazon Elastic Compute Cloud User Guide/. -- -- /See:/ 'newLaunchTemplateInstanceMetadataOptions' smart constructor. data LaunchTemplateInstanceMetadataOptions = LaunchTemplateInstanceMetadataOptions' { -- | 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. httpEndpoint :: Prelude.Maybe LaunchTemplateInstanceMetadataEndpointState, -- | Enables or disables the IPv6 endpoint for the instance metadata service. -- -- Default: @disabled@ httpProtocolIpv6 :: Prelude.Maybe LaunchTemplateInstanceMetadataProtocolIpv6, -- | 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 httpPutResponseHopLimit :: Prelude.Maybe Prelude.Int, -- | 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. httpTokens :: Prelude.Maybe LaunchTemplateHttpTokensState, -- | 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 -- . -- -- Default: @disabled@ instanceMetadataTags :: Prelude.Maybe LaunchTemplateInstanceMetadataTagsState, -- | 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. state :: Prelude.Maybe LaunchTemplateInstanceMetadataOptionsState } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'LaunchTemplateInstanceMetadataOptions' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'httpEndpoint', '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. -- -- 'httpProtocolIpv6', 'launchTemplateInstanceMetadataOptions_httpProtocolIpv6' - Enables or disables the IPv6 endpoint for the instance metadata service. -- -- Default: @disabled@ -- -- 'httpPutResponseHopLimit', '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 -- -- 'httpTokens', '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. -- -- 'instanceMetadataTags', '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 -- . -- -- Default: @disabled@ -- -- 'state', '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. newLaunchTemplateInstanceMetadataOptions :: LaunchTemplateInstanceMetadataOptions newLaunchTemplateInstanceMetadataOptions = LaunchTemplateInstanceMetadataOptions' { httpEndpoint = Prelude.Nothing, httpProtocolIpv6 = Prelude.Nothing, httpPutResponseHopLimit = Prelude.Nothing, httpTokens = Prelude.Nothing, instanceMetadataTags = Prelude.Nothing, state = Prelude.Nothing } -- | 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_httpEndpoint :: Lens.Lens' LaunchTemplateInstanceMetadataOptions (Prelude.Maybe LaunchTemplateInstanceMetadataEndpointState) launchTemplateInstanceMetadataOptions_httpEndpoint = Lens.lens (\LaunchTemplateInstanceMetadataOptions' {httpEndpoint} -> httpEndpoint) (\s@LaunchTemplateInstanceMetadataOptions' {} a -> s {httpEndpoint = a} :: LaunchTemplateInstanceMetadataOptions) -- | Enables or disables the IPv6 endpoint for the instance metadata service. -- -- Default: @disabled@ launchTemplateInstanceMetadataOptions_httpProtocolIpv6 :: Lens.Lens' LaunchTemplateInstanceMetadataOptions (Prelude.Maybe LaunchTemplateInstanceMetadataProtocolIpv6) launchTemplateInstanceMetadataOptions_httpProtocolIpv6 = Lens.lens (\LaunchTemplateInstanceMetadataOptions' {httpProtocolIpv6} -> httpProtocolIpv6) (\s@LaunchTemplateInstanceMetadataOptions' {} a -> s {httpProtocolIpv6 = a} :: LaunchTemplateInstanceMetadataOptions) -- | 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_httpPutResponseHopLimit :: Lens.Lens' LaunchTemplateInstanceMetadataOptions (Prelude.Maybe Prelude.Int) launchTemplateInstanceMetadataOptions_httpPutResponseHopLimit = Lens.lens (\LaunchTemplateInstanceMetadataOptions' {httpPutResponseHopLimit} -> httpPutResponseHopLimit) (\s@LaunchTemplateInstanceMetadataOptions' {} a -> s {httpPutResponseHopLimit = a} :: LaunchTemplateInstanceMetadataOptions) -- | 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_httpTokens :: Lens.Lens' LaunchTemplateInstanceMetadataOptions (Prelude.Maybe LaunchTemplateHttpTokensState) launchTemplateInstanceMetadataOptions_httpTokens = Lens.lens (\LaunchTemplateInstanceMetadataOptions' {httpTokens} -> httpTokens) (\s@LaunchTemplateInstanceMetadataOptions' {} a -> s {httpTokens = a} :: LaunchTemplateInstanceMetadataOptions) -- | 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 -- . -- -- Default: @disabled@ launchTemplateInstanceMetadataOptions_instanceMetadataTags :: Lens.Lens' LaunchTemplateInstanceMetadataOptions (Prelude.Maybe LaunchTemplateInstanceMetadataTagsState) launchTemplateInstanceMetadataOptions_instanceMetadataTags = Lens.lens (\LaunchTemplateInstanceMetadataOptions' {instanceMetadataTags} -> instanceMetadataTags) (\s@LaunchTemplateInstanceMetadataOptions' {} a -> s {instanceMetadataTags = a} :: LaunchTemplateInstanceMetadataOptions) -- | 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_state :: Lens.Lens' LaunchTemplateInstanceMetadataOptions (Prelude.Maybe LaunchTemplateInstanceMetadataOptionsState) launchTemplateInstanceMetadataOptions_state = Lens.lens (\LaunchTemplateInstanceMetadataOptions' {state} -> state) (\s@LaunchTemplateInstanceMetadataOptions' {} a -> s {state = a} :: LaunchTemplateInstanceMetadataOptions) instance Data.FromXML LaunchTemplateInstanceMetadataOptions where parseXML x = LaunchTemplateInstanceMetadataOptions' Prelude.<$> (x Data..@? "httpEndpoint") Prelude.<*> (x Data..@? "httpProtocolIpv6") Prelude.<*> (x Data..@? "httpPutResponseHopLimit") Prelude.<*> (x Data..@? "httpTokens") Prelude.<*> (x Data..@? "instanceMetadataTags") Prelude.<*> (x Data..@? "state") instance Prelude.Hashable LaunchTemplateInstanceMetadataOptions where hashWithSalt _salt LaunchTemplateInstanceMetadataOptions' {..} = _salt `Prelude.hashWithSalt` httpEndpoint `Prelude.hashWithSalt` httpProtocolIpv6 `Prelude.hashWithSalt` httpPutResponseHopLimit `Prelude.hashWithSalt` httpTokens `Prelude.hashWithSalt` instanceMetadataTags `Prelude.hashWithSalt` state instance Prelude.NFData LaunchTemplateInstanceMetadataOptions where rnf LaunchTemplateInstanceMetadataOptions' {..} = Prelude.rnf httpEndpoint `Prelude.seq` Prelude.rnf httpProtocolIpv6 `Prelude.seq` Prelude.rnf httpPutResponseHopLimit `Prelude.seq` Prelude.rnf httpTokens `Prelude.seq` Prelude.rnf instanceMetadataTags `Prelude.seq` Prelude.rnf state