Class: Aws::EC2::Types::InstanceMetadataOptionsRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ec2/types.rb

Overview

The metadata options for the instance.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#http_endpointString

Enables or disables the HTTP metadata endpoint on your instances.

If you specify a value of ‘disabled`, you cannot access your instance metadata.

Default: ‘enabled`

Returns:

  • (String)


39353
39354
39355
39356
39357
39358
39359
39360
39361
# File 'lib/aws-sdk-ec2/types.rb', line 39353

class InstanceMetadataOptionsRequest < Struct.new(
  :http_tokens,
  :http_put_response_hop_limit,
  :http_endpoint,
  :http_protocol_ipv_6,
  :instance_metadata_tags)
  SENSITIVE = []
  include Aws::Structure
end

#http_protocol_ipv_6String

Enables or disables the IPv6 endpoint for the instance metadata service.

Returns:

  • (String)


39353
39354
39355
39356
39357
39358
39359
39360
39361
# File 'lib/aws-sdk-ec2/types.rb', line 39353

class InstanceMetadataOptionsRequest < Struct.new(
  :http_tokens,
  :http_put_response_hop_limit,
  :http_endpoint,
  :http_protocol_ipv_6,
  :instance_metadata_tags)
  SENSITIVE = []
  include Aws::Structure
end

#http_put_response_hop_limitInteger

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

Returns:

  • (Integer)


39353
39354
39355
39356
39357
39358
39359
39360
39361
# File 'lib/aws-sdk-ec2/types.rb', line 39353

class InstanceMetadataOptionsRequest < Struct.new(
  :http_tokens,
  :http_put_response_hop_limit,
  :http_endpoint,
  :http_protocol_ipv_6,
  :instance_metadata_tags)
  SENSITIVE = []
  include Aws::Structure
end

#http_tokensString

IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to ‘optional` (in other words, set the use of IMDSv2 to `optional`) or `required` (in other words, set the use of IMDSv2 to `required`).

  • ‘optional` - When IMDSv2 is optional, you can choose to retrieve instance metadata with or without a session token in your request. If you retrieve the IAM role credentials without a token, the IMDSv1 role credentials are returned. If you retrieve the IAM role credentials using a valid session token, the IMDSv2 role credentials are returned.

  • ‘required` - When IMDSv2 is required, you must send a session token with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.

Default: ‘optional`

Returns:

  • (String)


39353
39354
39355
39356
39357
39358
39359
39360
39361
# File 'lib/aws-sdk-ec2/types.rb', line 39353

class InstanceMetadataOptionsRequest < Struct.new(
  :http_tokens,
  :http_put_response_hop_limit,
  :http_endpoint,
  :http_protocol_ipv_6,
  :instance_metadata_tags)
  SENSITIVE = []
  include Aws::Structure
end

#instance_metadata_tagsString

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`

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS

Returns:

  • (String)


39353
39354
39355
39356
39357
39358
39359
39360
39361
# File 'lib/aws-sdk-ec2/types.rb', line 39353

class InstanceMetadataOptionsRequest < Struct.new(
  :http_tokens,
  :http_put_response_hop_limit,
  :http_endpoint,
  :http_protocol_ipv_6,
  :instance_metadata_tags)
  SENSITIVE = []
  include Aws::Structure
end