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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass ModifyInstanceMetadataOptionsRequest data as a hash:

{
  instance_id: "InstanceId", # required
  http_tokens: "optional", # accepts optional, required
  http_put_response_hop_limit: 1,
  http_endpoint: "disabled", # accepts disabled, enabled
  dry_run: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dry_runBoolean

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)


35637
35638
35639
35640
35641
35642
35643
35644
35645
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 35637

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

#http_endpointString

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

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

Returns:

  • (String)


35637
35638
35639
35640
35641
35642
35643
35644
35645
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 35637

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

#http_put_response_hop_limitInteger

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)


35637
35638
35639
35640
35641
35642
35643
35644
35645
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 35637

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

#http_tokensString

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

Returns:

  • (String)


35637
35638
35639
35640
35641
35642
35643
35644
35645
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 35637

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

#instance_idString

The ID of the instance.

Returns:

  • (String)


35637
35638
35639
35640
35641
35642
35643
35644
35645
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 35637

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