Class: Aws::Lightsail::Types::UpdateInstanceMetadataOptionsRequest

Inherits:

Struct

• Object
• Struct
• Aws::Lightsail::Types::UpdateInstanceMetadataOptionsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-lightsail/types.rb

Overview

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

  The name of the instance for which to update metadata parameters.

Instance Attribute Details

#http_endpoint ⇒ String

Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.

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

Returns:

• (String)

# File 'lib/aws-sdk-lightsail/types.rb', line 14809

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

#http_protocol_ipv_6 ⇒ String

Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only when the HTTP metadata endpoint is enabled.

<note markdown=“1”> This parameter is available only for instances in the Europe (Stockholm) Amazon Web Services Region (‘eu-north-1`).

</note>

Returns:

• (String)

# File 'lib/aws-sdk-lightsail/types.rb', line 14809

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

#http_put_response_hop_limit ⇒ Integer

The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther. If no parameter is specified, the existing state is maintained.

Returns:

• (Integer)

# File 'lib/aws-sdk-lightsail/types.rb', line 14809

class UpdateInstanceMetadataOptionsRequest < Struct.new(
  :instance_name,
  :http_tokens,
  :http_endpoint,
  :http_put_response_hop_limit,
  :http_protocol_ipv_6)
  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 whether to retrieve instance metadata with 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 by 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 all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.

Returns:

• (String)

# File 'lib/aws-sdk-lightsail/types.rb', line 14809

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

#instance_name ⇒ String

The name of the instance for which to update metadata parameters.

Returns:

• (String)

# File 'lib/aws-sdk-lightsail/types.rb', line 14809

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