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 |
Synopsis
- data InstanceMetadataOptions = InstanceMetadataOptions' {}
- newInstanceMetadataOptions :: InstanceMetadataOptions
- instanceMetadataOptions_httpEndpoint :: Lens' InstanceMetadataOptions (Maybe HttpEndpoint)
- instanceMetadataOptions_httpProtocolIpv6 :: Lens' InstanceMetadataOptions (Maybe HttpProtocolIpv6)
- instanceMetadataOptions_httpPutResponseHopLimit :: Lens' InstanceMetadataOptions (Maybe Int)
- instanceMetadataOptions_httpTokens :: Lens' InstanceMetadataOptions (Maybe HttpTokens)
- instanceMetadataOptions_state :: Lens' InstanceMetadataOptions (Maybe InstanceMetadataState)
Documentation
data InstanceMetadataOptions Source #
The metadata options for the instance.
See: newInstanceMetadataOptions
smart constructor.
InstanceMetadataOptions' | |
|
Instances
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
- Indicates whether the HTTP metadata endpoint on your instances is
enabled or disabled.
If the value is disabled
, you cannot access your instance metadata.
$sel:httpProtocolIpv6:InstanceMetadataOptions'
, instanceMetadataOptions_httpProtocolIpv6
- Indicates whether the IPv6 endpoint for the instance metadata service is
enabled or disabled.
$sel:httpPutResponseHopLimit:InstanceMetadataOptions'
, instanceMetadataOptions_httpPutResponseHopLimit
- The desired HTTP PUT response hop limit for instance metadata requests.
A larger number means that the instance metadata requests can travel
farther.
$sel:httpTokens:InstanceMetadataOptions'
, instanceMetadataOptions_httpTokens
- The state of token usage for your instance metadata requests.
If the state is optional
, you can choose whether to retrieve instance
metadata with 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 by 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 all
instance metadata retrieval requests. In this state, retrieving the IAM
role credential always returns the version 2.0 credentials. The version
1.0 credentials are not available.
Not all instance blueprints in Lightsail support version 2.0
credentials. Use the MetadataNoToken
instance metric to track the
number of calls to the instance metadata service that are using version
1.0 credentials. For more information, see
Viewing instance metrics in Amazon Lightsail
in the Amazon Lightsail Developer Guide.
$sel:state:InstanceMetadataOptions'
, instanceMetadataOptions_state
- The state of the metadata option changes.
The following states are possible:
pending
- The metadata options are being updated. The instance is not yet ready to process metadata traffic with the new selection.applied
- The metadata options have been successfully applied to the instance.
instanceMetadataOptions_httpEndpoint :: Lens' InstanceMetadataOptions (Maybe HttpEndpoint) Source #
Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.
If the value is disabled
, you cannot access your instance metadata.
instanceMetadataOptions_httpProtocolIpv6 :: Lens' InstanceMetadataOptions (Maybe HttpProtocolIpv6) Source #
Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.
instanceMetadataOptions_httpPutResponseHopLimit :: Lens' InstanceMetadataOptions (Maybe Int) Source #
The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther.
instanceMetadataOptions_httpTokens :: Lens' InstanceMetadataOptions (Maybe HttpTokens) Source #
The state of token usage for your instance metadata requests.
If the state is optional
, you can choose whether to retrieve instance
metadata with 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 by 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 all
instance metadata retrieval requests. In this state, retrieving the IAM
role credential always returns the version 2.0 credentials. The version
1.0 credentials are not available.
Not all instance blueprints in Lightsail support version 2.0
credentials. Use the MetadataNoToken
instance metric to track the
number of calls to the instance metadata service that are using version
1.0 credentials. For more information, see
Viewing instance metrics in Amazon Lightsail
in the Amazon Lightsail Developer Guide.
instanceMetadataOptions_state :: Lens' InstanceMetadataOptions (Maybe InstanceMetadataState) Source #
The state of the metadata option changes.
The following states are possible:
pending
- The metadata options are being updated. The instance is not yet ready to process metadata traffic with the new selection.applied
- The metadata options have been successfully applied to the instance.