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

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

Overview

Note:

When making an API call, you may pass InstanceMetadataOptionsRequest data as a hash:

{
  http_tokens: "optional", # accepts optional, required
  http_put_response_hop_limit: 1,
  http_endpoint: "disabled", # accepts disabled, enabled
  http_protocol_ipv_6: "disabled", # accepts disabled, enabled
  instance_metadata_tags: "disabled", # accepts disabled, enabled
}

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)


40061
40062
40063
40064
40065
40066
40067
40068
40069
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 40061

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)


40061
40062
40063
40064
40065
40066
40067
40068
40069
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 40061

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)


40061
40062
40063
40064
40065
40066
40067
40068
40069
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 40061

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

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 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 credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.

Default: optional

Returns:

  • (String)


40061
40062
40063
40064
40065
40066
40067
40068
40069
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 40061

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

Returns:

  • (String)


40061
40062
40063
40064
40065
40066
40067
40068
40069
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 40061

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