Class: Aws::EC2::Types::LaunchTemplateInstanceMetadataOptionsRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::LaunchTemplateInstanceMetadataOptionsRequest

Defined in:

gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass LaunchTemplateInstanceMetadataOptionsRequest 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. For more information, see Instance metadata and user data in the Amazon Elastic Compute Cloud User Guide.

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 desired HTTP PUT response hop limit for instance metadata requests.

• #http_tokens ⇒ String

  The state of token usage for your instance metadata requests.

• #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 the parameter is not specified, the default state is enabled.

If you specify a value of disabled, you will not be able to access your instance metadata.

Returns:

• (String)

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

class LaunchTemplateInstanceMetadataOptionsRequest < 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 45649

class LaunchTemplateInstanceMetadataOptionsRequest < 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 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 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 45649

class LaunchTemplateInstanceMetadataOptionsRequest < 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

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

Returns:

• (String)

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

class LaunchTemplateInstanceMetadataOptionsRequest < 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 45649

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