Skip to content

UpdateInstanceMetadataOptionsRequest

Source code in docs_src/capo_lightsail/types/update_instance_metadata_options_request.py
class UpdateInstanceMetadataOptionsRequest(TypedDict, closed=True):
    instance_name: "capo_lightsail.types.resource_name.ResourceName"
    """<p>The name of the instance for which to update metadata parameters.</p>"""
    http_tokens: NotRequired["capo_lightsail.types.http_tokens.HttpTokens"]
    """<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 whether to retrieve instance metadata with 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 by 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 all 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.</p>"""
    http_endpoint: NotRequired["capo_lightsail.types.http_endpoint.HttpEndpoint"]
    """<p>Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.</p> <p>If you specify a value of <code>disabled</code>, you cannot access your instance metadata.</p>"""
    http_put_response_hop_limit: NotRequired["capo_lightsail.types.integer.integer"]
    """<p>The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther. If no parameter is specified, the existing state is maintained.</p>"""
    http_protocol_ipv6: NotRequired[
        "capo_lightsail.types.http_protocol_ipv6.HttpProtocolIpv6"
    ]
    """<p>Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only when the HTTP metadata endpoint is enabled.</p> <note> <p>This parameter is available only for instances in the Europe (Stockholm) Amazon Web Services Region (<code>eu-north-1</code>).</p> </note>"""

http_endpoint instance-attribute

http_endpoint: NotRequired[HttpEndpoint]

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.

http_protocol_ipv6 instance-attribute

http_protocol_ipv6: NotRequired[HttpProtocolIpv6]

Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only when the HTTP metadata endpoint is enabled.

This parameter is available only for instances in the Europe (Stockholm) Amazon Web Services Region (eu-north-1).

http_put_response_hop_limit instance-attribute

http_put_response_hop_limit: NotRequired[integer]

The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther. If no parameter is specified, the existing state is maintained.

http_tokens instance-attribute

http_tokens: NotRequired[HttpTokens]

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 whether to retrieve instance metadata with 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 by 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 all 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.

instance_name instance-attribute

instance_name: ResourceName

The name of the instance for which to update metadata parameters.