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 InstanceMetadataOptionsResponse = InstanceMetadataOptionsResponse' {}
- newInstanceMetadataOptionsResponse :: InstanceMetadataOptionsResponse
- instanceMetadataOptionsResponse_httpEndpoint :: Lens' InstanceMetadataOptionsResponse (Maybe InstanceMetadataEndpointState)
- instanceMetadataOptionsResponse_httpProtocolIpv6 :: Lens' InstanceMetadataOptionsResponse (Maybe InstanceMetadataProtocolState)
- instanceMetadataOptionsResponse_httpPutResponseHopLimit :: Lens' InstanceMetadataOptionsResponse (Maybe Int)
- instanceMetadataOptionsResponse_httpTokens :: Lens' InstanceMetadataOptionsResponse (Maybe HttpTokensState)
- instanceMetadataOptionsResponse_instanceMetadataTags :: Lens' InstanceMetadataOptionsResponse (Maybe InstanceMetadataTagsState)
- instanceMetadataOptionsResponse_state :: Lens' InstanceMetadataOptionsResponse (Maybe InstanceMetadataOptionsState)
Documentation
data InstanceMetadataOptionsResponse Source #
The metadata options for the instance.
See: newInstanceMetadataOptionsResponse
smart constructor.
InstanceMetadataOptionsResponse' | |
|
Instances
newInstanceMetadataOptionsResponse :: InstanceMetadataOptionsResponse Source #
Create a value of InstanceMetadataOptionsResponse
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:InstanceMetadataOptionsResponse'
, instanceMetadataOptionsResponse_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:InstanceMetadataOptionsResponse'
, instanceMetadataOptionsResponse_httpProtocolIpv6
- Indicates whether the IPv6 endpoint for the instance metadata service is
enabled or disabled.
$sel:httpPutResponseHopLimit:InstanceMetadataOptionsResponse'
, instanceMetadataOptionsResponse_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:InstanceMetadataOptionsResponse'
, instanceMetadataOptionsResponse_httpTokens
- The state of token usage for your instance metadata requests.
If the state is optional
, you can choose to retrieve instance metadata
with or without a session token 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 session
token, the version 2.0 role credentials are returned.
If the state is required
, you must send a session token 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.
Default: optional
$sel:instanceMetadataTags:InstanceMetadataOptionsResponse'
, instanceMetadataOptionsResponse_instanceMetadataTags
- Indicates whether access to instance tags from the instance metadata is
enabled or disabled. For more information, see
Work with instance tags using the instance metadata.
$sel:state:InstanceMetadataOptionsResponse'
, instanceMetadataOptionsResponse_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.
instanceMetadataOptionsResponse_httpEndpoint :: Lens' InstanceMetadataOptionsResponse (Maybe InstanceMetadataEndpointState) 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.
instanceMetadataOptionsResponse_httpProtocolIpv6 :: Lens' InstanceMetadataOptionsResponse (Maybe InstanceMetadataProtocolState) Source #
Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.
instanceMetadataOptionsResponse_httpPutResponseHopLimit :: Lens' InstanceMetadataOptionsResponse (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
instanceMetadataOptionsResponse_httpTokens :: Lens' InstanceMetadataOptionsResponse (Maybe HttpTokensState) Source #
The state of token usage for your instance metadata requests.
If the state is optional
, you can choose to retrieve instance metadata
with or without a session token 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 session
token, the version 2.0 role credentials are returned.
If the state is required
, you must send a session token 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.
Default: optional
instanceMetadataOptionsResponse_instanceMetadataTags :: Lens' InstanceMetadataOptionsResponse (Maybe InstanceMetadataTagsState) Source #
Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata.
instanceMetadataOptionsResponse_state :: Lens' InstanceMetadataOptionsResponse (Maybe InstanceMetadataOptionsState) 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.