Class: Aws::EC2::Types::ModifyInstanceMetadataOptionsRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::ModifyInstanceMetadataOptionsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #dry_run ⇒ Boolean

  Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

• #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

  Indicates whether IMDSv2 is required.

• #instance_id ⇒ String

  The ID of the instance.

• #instance_metadata_tags ⇒ String

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

Instance Attribute Details

#dry_run ⇒ Boolean

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is ‘DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.

Returns:

• (Boolean)

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

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

#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-ec2/types.rb', line 51638

class ModifyInstanceMetadataOptionsRequest < Struct.new(
  :instance_id,
  :http_tokens,
  :http_put_response_hop_limit,
  :http_endpoint,
  :dry_run,
  :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. Applies only if you enabled the HTTP metadata endpoint.

Returns:

• (String)

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

class ModifyInstanceMetadataOptionsRequest < Struct.new(
  :instance_id,
  :http_tokens,
  :http_put_response_hop_limit,
  :http_endpoint,
  :dry_run,
  :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. If no parameter is specified, the existing state is maintained.

Possible values: Integers from 1 to 64

Returns:

• (Integer)

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

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

#http_tokens ⇒ String

Indicates whether IMDSv2 is required.

• ‘optional` - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials.

• ‘required` - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.

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*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html#instance-metadata-options-order-of-precedence

Returns:

• (String)

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

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

#instance_id ⇒ String

The ID of the instance.

Returns:

• (String)

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

class ModifyInstanceMetadataOptionsRequest < Struct.new(
  :instance_id,
  :http_tokens,
  :http_put_response_hop_limit,
  :http_endpoint,
  :dry_run,
  :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].

[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 51638

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