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 |
Modifies the Amazon Lightsail instance metadata parameters on a running
or stopped instance. When you modify the parameters on a running
instance, the GetInstance
or GetInstances
API operation initially
responds with a state of pending
. After the parameter modifications
are successfully applied, the state changes to applied
in subsequent
GetInstance
or GetInstances
API calls. For more information, see
Use IMDSv2 with an Amazon Lightsail instance
in the Amazon Lightsail Developer Guide.
Synopsis
- data UpdateInstanceMetadataOptions = UpdateInstanceMetadataOptions' {}
- newUpdateInstanceMetadataOptions :: Text -> UpdateInstanceMetadataOptions
- updateInstanceMetadataOptions_httpEndpoint :: Lens' UpdateInstanceMetadataOptions (Maybe HttpEndpoint)
- updateInstanceMetadataOptions_httpProtocolIpv6 :: Lens' UpdateInstanceMetadataOptions (Maybe HttpProtocolIpv6)
- updateInstanceMetadataOptions_httpPutResponseHopLimit :: Lens' UpdateInstanceMetadataOptions (Maybe Int)
- updateInstanceMetadataOptions_httpTokens :: Lens' UpdateInstanceMetadataOptions (Maybe HttpTokens)
- updateInstanceMetadataOptions_instanceName :: Lens' UpdateInstanceMetadataOptions Text
- data UpdateInstanceMetadataOptionsResponse = UpdateInstanceMetadataOptionsResponse' {
- operation :: Maybe Operation
- httpStatus :: Int
- newUpdateInstanceMetadataOptionsResponse :: Int -> UpdateInstanceMetadataOptionsResponse
- updateInstanceMetadataOptionsResponse_operation :: Lens' UpdateInstanceMetadataOptionsResponse (Maybe Operation)
- updateInstanceMetadataOptionsResponse_httpStatus :: Lens' UpdateInstanceMetadataOptionsResponse Int
Creating a Request
data UpdateInstanceMetadataOptions Source #
See: newUpdateInstanceMetadataOptions
smart constructor.
UpdateInstanceMetadataOptions' | |
|
Instances
newUpdateInstanceMetadataOptions Source #
Create a value of UpdateInstanceMetadataOptions
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:
UpdateInstanceMetadataOptions
, updateInstanceMetadataOptions_httpEndpoint
- Enables or disables the HTTP metadata endpoint on your instances. If
this parameter is not specified, the existing state is maintained.
If you specify a value of disabled
, you cannot access your instance
metadata.
UpdateInstanceMetadataOptions
, updateInstanceMetadataOptions_httpProtocolIpv6
- Enables or disables the IPv6 endpoint for the instance metadata service.
This setting applies only when the HTTP metadata endpoint is enabled.
This parameter is available only for instances in the Europe (Stockholm)
Amazon Web Services Region (eu-north-1
).
UpdateInstanceMetadataOptions
, updateInstanceMetadataOptions_httpPutResponseHopLimit
- The desired HTTP PUT response hop limit for instance metadata requests.
A larger number means that the instance metadata requests can travel
farther. If no parameter is specified, the existing state is maintained.
UpdateInstanceMetadataOptions
, updateInstanceMetadataOptions_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 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.
UpdateInstanceMetadataOptions
, updateInstanceMetadataOptions_instanceName
- The name of the instance for which to update metadata parameters.
Request Lenses
updateInstanceMetadataOptions_httpEndpoint :: Lens' UpdateInstanceMetadataOptions (Maybe HttpEndpoint) Source #
Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.
If you specify a value of disabled
, you cannot access your instance
metadata.
updateInstanceMetadataOptions_httpProtocolIpv6 :: Lens' UpdateInstanceMetadataOptions (Maybe HttpProtocolIpv6) Source #
Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only when the HTTP metadata endpoint is enabled.
This parameter is available only for instances in the Europe (Stockholm)
Amazon Web Services Region (eu-north-1
).
updateInstanceMetadataOptions_httpPutResponseHopLimit :: Lens' UpdateInstanceMetadataOptions (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. If no parameter is specified, the existing state is maintained.
updateInstanceMetadataOptions_httpTokens :: Lens' UpdateInstanceMetadataOptions (Maybe HttpTokens) 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 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.
updateInstanceMetadataOptions_instanceName :: Lens' UpdateInstanceMetadataOptions Text Source #
The name of the instance for which to update metadata parameters.
Destructuring the Response
data UpdateInstanceMetadataOptionsResponse Source #
See: newUpdateInstanceMetadataOptionsResponse
smart constructor.
UpdateInstanceMetadataOptionsResponse' | |
|
Instances
newUpdateInstanceMetadataOptionsResponse Source #
Create a value of UpdateInstanceMetadataOptionsResponse
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:operation:UpdateInstanceMetadataOptionsResponse'
, updateInstanceMetadataOptionsResponse_operation
- Undocumented member.
$sel:httpStatus:UpdateInstanceMetadataOptionsResponse'
, updateInstanceMetadataOptionsResponse_httpStatus
- The response's http status code.
Response Lenses
updateInstanceMetadataOptionsResponse_operation :: Lens' UpdateInstanceMetadataOptionsResponse (Maybe Operation) Source #
Undocumented member.
updateInstanceMetadataOptionsResponse_httpStatus :: Lens' UpdateInstanceMetadataOptionsResponse Int Source #
The response's http status code.