Documentation

The metadata options for the instance.

See: newInstanceMetadataOptionsResponse smart constructor.

Create a value of InstanceMetadataOptionsResponse 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:InstanceMetadataOptionsResponse', instanceMetadataOptionsResponse_httpEndpoint - Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

If the value is disabled, you cannot access your instance metadata.

$sel:httpProtocolIpv6:InstanceMetadataOptionsResponse', instanceMetadataOptionsResponse_httpProtocolIpv6 - Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

$sel:httpPutResponseHopLimit:InstanceMetadataOptionsResponse', instanceMetadataOptionsResponse_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:InstanceMetadataOptionsResponse', instanceMetadataOptionsResponse_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:InstanceMetadataOptionsResponse', instanceMetadataOptionsResponse_instanceMetadataTags - Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata.

$sel:state:InstanceMetadataOptionsResponse', instanceMetadataOptionsResponse_state - The state of the metadata option changes.

pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.

applied - The metadata options have been successfully applied on the instance.

Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

If the value is disabled, you cannot access your instance metadata.

Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

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

Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata.

The state of the metadata option changes.

pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.

applied - The metadata options have been successfully applied on the instance.