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 |
Modify the instance metadata parameters on a running or stopped instance. When you modify the parameters on a stopped instance, they are applied when the instance is started. When you modify the parameters on a running instance, the API responds with a state of “pending”. After the parameter modifications are successfully applied to the instance, the state of the modifications changes from “pending” to “applied” in subsequent describe-instances API calls. For more information, see Instance metadata and user data in the Amazon EC2 User Guide.
Synopsis
- data ModifyInstanceMetadataOptions = ModifyInstanceMetadataOptions' {}
- newModifyInstanceMetadataOptions :: Text -> ModifyInstanceMetadataOptions
- modifyInstanceMetadataOptions_dryRun :: Lens' ModifyInstanceMetadataOptions (Maybe Bool)
- modifyInstanceMetadataOptions_httpEndpoint :: Lens' ModifyInstanceMetadataOptions (Maybe InstanceMetadataEndpointState)
- modifyInstanceMetadataOptions_httpProtocolIpv6 :: Lens' ModifyInstanceMetadataOptions (Maybe InstanceMetadataProtocolState)
- modifyInstanceMetadataOptions_httpPutResponseHopLimit :: Lens' ModifyInstanceMetadataOptions (Maybe Int)
- modifyInstanceMetadataOptions_httpTokens :: Lens' ModifyInstanceMetadataOptions (Maybe HttpTokensState)
- modifyInstanceMetadataOptions_instanceMetadataTags :: Lens' ModifyInstanceMetadataOptions (Maybe InstanceMetadataTagsState)
- modifyInstanceMetadataOptions_instanceId :: Lens' ModifyInstanceMetadataOptions Text
- data ModifyInstanceMetadataOptionsResponse = ModifyInstanceMetadataOptionsResponse' {}
- newModifyInstanceMetadataOptionsResponse :: Int -> ModifyInstanceMetadataOptionsResponse
- modifyInstanceMetadataOptionsResponse_instanceId :: Lens' ModifyInstanceMetadataOptionsResponse (Maybe Text)
- modifyInstanceMetadataOptionsResponse_instanceMetadataOptions :: Lens' ModifyInstanceMetadataOptionsResponse (Maybe InstanceMetadataOptionsResponse)
- modifyInstanceMetadataOptionsResponse_httpStatus :: Lens' ModifyInstanceMetadataOptionsResponse Int
Creating a Request
data ModifyInstanceMetadataOptions Source #
See: newModifyInstanceMetadataOptions
smart constructor.
ModifyInstanceMetadataOptions' | |
|
Instances
newModifyInstanceMetadataOptions Source #
Create a value of ModifyInstanceMetadataOptions
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:dryRun:ModifyInstanceMetadataOptions'
, modifyInstanceMetadataOptions_dryRun
- Checks whether you have the required permissions for the action, without
actually making the request, and provides an error response. If you have
the required permissions, the error response is DryRunOperation
.
Otherwise, it is UnauthorizedOperation
.
ModifyInstanceMetadataOptions
, modifyInstanceMetadataOptions_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.
ModifyInstanceMetadataOptions
, modifyInstanceMetadataOptions_httpProtocolIpv6
- Enables or disables the IPv6 endpoint for the instance metadata service.
This setting applies only if you have enabled the HTTP metadata
endpoint.
ModifyInstanceMetadataOptions
, modifyInstanceMetadataOptions_httpPutResponseHopLimit
- The desired HTTP PUT response hop limit for instance metadata requests.
The larger the number, the further instance metadata requests can
travel. If no parameter is specified, the existing state is maintained.
Possible values: Integers from 1 to 64
ModifyInstanceMetadataOptions
, modifyInstanceMetadataOptions_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 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.
ModifyInstanceMetadataOptions
, modifyInstanceMetadataOptions_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
ModifyInstanceMetadataOptions
, modifyInstanceMetadataOptions_instanceId
- The ID of the instance.
Request Lenses
modifyInstanceMetadataOptions_dryRun :: Lens' ModifyInstanceMetadataOptions (Maybe Bool) Source #
Checks whether you have the required permissions for the action, without
actually making the request, and provides an error response. If you have
the required permissions, the error response is DryRunOperation
.
Otherwise, it is UnauthorizedOperation
.
modifyInstanceMetadataOptions_httpEndpoint :: Lens' ModifyInstanceMetadataOptions (Maybe InstanceMetadataEndpointState) 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.
modifyInstanceMetadataOptions_httpProtocolIpv6 :: Lens' ModifyInstanceMetadataOptions (Maybe InstanceMetadataProtocolState) Source #
Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only if you have enabled the HTTP metadata endpoint.
modifyInstanceMetadataOptions_httpPutResponseHopLimit :: Lens' ModifyInstanceMetadataOptions (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. If no parameter is specified, the existing state is maintained.
Possible values: Integers from 1 to 64
modifyInstanceMetadataOptions_httpTokens :: Lens' ModifyInstanceMetadataOptions (Maybe HttpTokensState) 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 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.
modifyInstanceMetadataOptions_instanceMetadataTags :: Lens' ModifyInstanceMetadataOptions (Maybe InstanceMetadataTagsState) 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
modifyInstanceMetadataOptions_instanceId :: Lens' ModifyInstanceMetadataOptions Text Source #
The ID of the instance.
Destructuring the Response
data ModifyInstanceMetadataOptionsResponse Source #
See: newModifyInstanceMetadataOptionsResponse
smart constructor.
ModifyInstanceMetadataOptionsResponse' | |
|
Instances
newModifyInstanceMetadataOptionsResponse Source #
Create a value of ModifyInstanceMetadataOptionsResponse
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:
ModifyInstanceMetadataOptions
, modifyInstanceMetadataOptionsResponse_instanceId
- The ID of the instance.
$sel:instanceMetadataOptions:ModifyInstanceMetadataOptionsResponse'
, modifyInstanceMetadataOptionsResponse_instanceMetadataOptions
- The metadata options for the instance.
$sel:httpStatus:ModifyInstanceMetadataOptionsResponse'
, modifyInstanceMetadataOptionsResponse_httpStatus
- The response's http status code.
Response Lenses
modifyInstanceMetadataOptionsResponse_instanceId :: Lens' ModifyInstanceMetadataOptionsResponse (Maybe Text) Source #
The ID of the instance.
modifyInstanceMetadataOptionsResponse_instanceMetadataOptions :: Lens' ModifyInstanceMetadataOptionsResponse (Maybe InstanceMetadataOptionsResponse) Source #
The metadata options for the instance.
modifyInstanceMetadataOptionsResponse_httpStatus :: Lens' ModifyInstanceMetadataOptionsResponse Int Source #
The response's http status code.