amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.Types.LaunchTemplateInstanceMetadataOptionsRequest

Description

 
Synopsis

Documentation

data LaunchTemplateInstanceMetadataOptionsRequest 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: newLaunchTemplateInstanceMetadataOptionsRequest smart constructor.

Constructors

LaunchTemplateInstanceMetadataOptionsRequest' 

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

Instances

Instances details
ToQuery LaunchTemplateInstanceMetadataOptionsRequest Source # 
Instance details

Defined in Amazonka.EC2.Types.LaunchTemplateInstanceMetadataOptionsRequest

Generic LaunchTemplateInstanceMetadataOptionsRequest Source # 
Instance details

Defined in Amazonka.EC2.Types.LaunchTemplateInstanceMetadataOptionsRequest

Read LaunchTemplateInstanceMetadataOptionsRequest Source # 
Instance details

Defined in Amazonka.EC2.Types.LaunchTemplateInstanceMetadataOptionsRequest

Show LaunchTemplateInstanceMetadataOptionsRequest Source # 
Instance details

Defined in Amazonka.EC2.Types.LaunchTemplateInstanceMetadataOptionsRequest

NFData LaunchTemplateInstanceMetadataOptionsRequest Source # 
Instance details

Defined in Amazonka.EC2.Types.LaunchTemplateInstanceMetadataOptionsRequest

Eq LaunchTemplateInstanceMetadataOptionsRequest Source # 
Instance details

Defined in Amazonka.EC2.Types.LaunchTemplateInstanceMetadataOptionsRequest

Hashable LaunchTemplateInstanceMetadataOptionsRequest Source # 
Instance details

Defined in Amazonka.EC2.Types.LaunchTemplateInstanceMetadataOptionsRequest

type Rep LaunchTemplateInstanceMetadataOptionsRequest Source # 
Instance details

Defined in Amazonka.EC2.Types.LaunchTemplateInstanceMetadataOptionsRequest

type Rep LaunchTemplateInstanceMetadataOptionsRequest = D1 ('MetaData "LaunchTemplateInstanceMetadataOptionsRequest" "Amazonka.EC2.Types.LaunchTemplateInstanceMetadataOptionsRequest" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "LaunchTemplateInstanceMetadataOptionsRequest'" '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))))))

newLaunchTemplateInstanceMetadataOptionsRequest :: LaunchTemplateInstanceMetadataOptionsRequest Source #

Create a value of LaunchTemplateInstanceMetadataOptionsRequest 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:LaunchTemplateInstanceMetadataOptionsRequest', launchTemplateInstanceMetadataOptionsRequest_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:LaunchTemplateInstanceMetadataOptionsRequest', launchTemplateInstanceMetadataOptionsRequest_httpProtocolIpv6 - Enables or disables the IPv6 endpoint for the instance metadata service.

Default: disabled

$sel:httpPutResponseHopLimit:LaunchTemplateInstanceMetadataOptionsRequest', launchTemplateInstanceMetadataOptionsRequest_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:LaunchTemplateInstanceMetadataOptionsRequest', launchTemplateInstanceMetadataOptionsRequest_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:LaunchTemplateInstanceMetadataOptionsRequest', launchTemplateInstanceMetadataOptionsRequest_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

launchTemplateInstanceMetadataOptionsRequest_httpEndpoint :: Lens' LaunchTemplateInstanceMetadataOptionsRequest (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.

launchTemplateInstanceMetadataOptionsRequest_httpPutResponseHopLimit :: Lens' LaunchTemplateInstanceMetadataOptionsRequest (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

launchTemplateInstanceMetadataOptionsRequest_httpTokens :: Lens' LaunchTemplateInstanceMetadataOptionsRequest (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.

launchTemplateInstanceMetadataOptionsRequest_instanceMetadataTags :: Lens' LaunchTemplateInstanceMetadataOptionsRequest (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