You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::EC2::Types::ModifyInstanceMetadataOptionsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::EC2::Types::ModifyInstanceMetadataOptionsRequest
- Defined in:
- (unknown)
Overview
When passing ModifyInstanceMetadataOptionsRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
instance_id: "InstanceId", # required
http_tokens: "optional", # accepts optional, required
http_put_response_hop_limit: 1,
http_endpoint: "disabled", # accepts disabled, enabled
dry_run: false,
}
Instance Attribute Summary collapse
-
#dry_run ⇒ Boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
-
#http_endpoint ⇒ String
This parameter enables or disables the HTTP metadata endpoint on your instances.
-
#http_put_response_hop_limit ⇒ Integer
The desired HTTP PUT response hop limit for instance metadata requests.
-
#http_tokens ⇒ String
The state of token usage for your instance metadata requests.
-
#instance_id ⇒ String
The ID of the instance.
Instance Attribute Details
#dry_run ⇒ Boolean
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
.
#http_endpoint ⇒ String
This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the existing state is maintained.
disabled
, you will not be able to access
your instance metadata.
Possible values:
- disabled
- enabled
#http_put_response_hop_limit ⇒ Integer
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
#http_tokens ⇒ String
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 credential always returns the version 2.0 credentials; the version
1.0 credentials are not available.
Possible values:
- optional
- required
#instance_id ⇒ String
The ID of the instance.