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

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::InstanceMetadataOptionsRequest

Defined in:

gems/aws-sdk-ec2/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

  Enables or disables the HTTP metadata endpoint on your instances.

• #http_protocol_ipv_6 ⇒ String

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

• #http_put_response_hop_limit ⇒ Integer

  The maximum number of hops that the metadata token can travel.

• #http_tokens ⇒ String

  Indicates whether IMDSv2 is required.

• #instance_metadata_tags ⇒ String

  Set to enabled to allow access to instance tags from the instance metadata.

Instance Attribute Details

#http_endpoint ⇒ String

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)

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

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_6 ⇒ String

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

Default: disabled

Returns:

• (String)

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

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_limit ⇒ Integer

The maximum number of hops that the metadata token can travel.

Possible values: Integers from 1 to 64

Returns:

• (Integer)

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

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_tokens ⇒ String

Indicates whether IMDSv2 is required.

• optional - IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1.

• required - IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2.

Default:

• If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0 and the account level default is set to no-preference, the default is required.

• If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, but the account level default is set to V1 or V2, the default is optional.

The default value can also be affected by other combinations of parameters. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.

Returns:

• (String)

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

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_tags ⇒ String

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)

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

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