Documentation

The metadata options for the instance.

See: newInstanceMetadataOptionsRequest smart constructor.

Create a value of InstanceMetadataOptionsRequest with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpEndpoint:InstanceMetadataOptionsRequest', instanceMetadataOptionsRequest_httpEndpoint - 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

$sel:httpProtocolIpv6:InstanceMetadataOptionsRequest', instanceMetadataOptionsRequest_httpProtocolIpv6 - Enables or disables the IPv6 endpoint for the instance metadata service.

$sel:httpPutResponseHopLimit:InstanceMetadataOptionsRequest', instanceMetadataOptionsRequest_httpPutResponseHopLimit - 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

$sel:httpTokens:InstanceMetadataOptionsRequest', instanceMetadataOptionsRequest_httpTokens - The state of token usage for your instance metadata requests.

If the state is optional, you can choose to retrieve instance metadata with or without a session token 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 session token, the version 2.0 role credentials are returned.

If the state is required, you must send a session token 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.

Default: optional

$sel:instanceMetadataTags:InstanceMetadataOptionsRequest', instanceMetadataOptionsRequest_instanceMetadataTags - 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

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

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

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

The state of token usage for your instance metadata requests.

If the state is optional, you can choose to retrieve instance metadata with or without a session token 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 session token, the version 2.0 role credentials are returned.

If the state is required, you must send a session token 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.

Default: optional

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