Class: Aws::EC2::Types::InstanceMetadataOptionsResponse

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::InstanceMetadataOptionsResponse

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

The metadata options for the instance.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #http_endpoint ⇒ String

  Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

• #http_protocol_ipv_6 ⇒ String

  Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

• #http_put_response_hop_limit ⇒ Integer

  The desired HTTP PUT response hop limit for instance metadata requests.

• #http_tokens ⇒ String

  IMDSv2 uses token-backed sessions.

• #instance_metadata_tags ⇒ String

  Indicates whether access to instance tags from the instance metadata is enabled or disabled.

• #state ⇒ String

  The state of the metadata option changes.

Instance Attribute Details

#http_endpoint ⇒ String

Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

If the value is ‘disabled`, you cannot access your instance metadata.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 39431

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

#http_protocol_ipv_6 ⇒ String

Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 39431

class InstanceMetadataOptionsResponse < Struct.new(
  :state,
  :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_limit ⇒ Integer

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)

# File 'lib/aws-sdk-ec2/types.rb', line 39431

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

#http_tokens ⇒ String

IMDSv2 uses token-backed sessions. Indicates whether the use of HTTP tokens is ‘optional` (in other words, indicates whether the use of IMDSv2 is `optional`) or `required` (in other words, indicates whether the use of IMDSv2 is `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)

# File 'lib/aws-sdk-ec2/types.rb', line 39431

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

#instance_metadata_tags ⇒ String

Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see [Work with instance tags using the instance metadata].

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

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 39431

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

#state ⇒ String

The state of the metadata option changes.

‘pending` - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.

‘applied` - The metadata options have been successfully applied on the instance.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 39431

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