Skip to content

InstanceMetadataOptions

Source code in docs_src/capo_auto_scaling/types/instance_metadata_options.py
class InstanceMetadataOptions(TypedDict, closed=True):
    http_tokens: NotRequired[
        "capo_auto_scaling.types.instance_metadata_http_tokens_state.InstanceMetadataHttpTokensState"
    ]
    """<p>The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is <code>optional</code>.</p> <p>If the state is <code>optional</code>, 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.</p> <p>If the state is <code>required</code>, you must send a signed token header 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.</p>"""
    http_put_response_hop_limit: NotRequired[
        "capo_auto_scaling.types.instance_metadata_http_put_response_hop_limit.InstanceMetadataHttpPutResponseHopLimit"
    ]
    """<p>The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.</p> <p>Default: 1</p>"""
    http_endpoint: NotRequired[
        "capo_auto_scaling.types.instance_metadata_endpoint_state.InstanceMetadataEndpointState"
    ]
    """<p>This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is <code>enabled</code>.</p> <note> <p>If you specify a value of <code>disabled</code>, you will not be able to access your instance metadata. </p> </note>"""

http_endpoint instance-attribute

http_endpoint: NotRequired[InstanceMetadataEndpointState]

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

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

http_put_response_hop_limit instance-attribute

http_put_response_hop_limit: NotRequired[InstanceMetadataHttpPutResponseHopLimit]

The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.

Default: 1

http_tokens instance-attribute

http_tokens: NotRequired[InstanceMetadataHttpTokensState]

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