aws_sdk_lightsail/client/

update_instance_metadata_options.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdateInstanceMetadataOptions`](crate::operation::update_instance_metadata_options::builders::UpdateInstanceMetadataOptionsFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`instance_name(impl Into<String>)`](crate::operation::update_instance_metadata_options::builders::UpdateInstanceMetadataOptionsFluentBuilder::instance_name) / [`set_instance_name(Option<String>)`](crate::operation::update_instance_metadata_options::builders::UpdateInstanceMetadataOptionsFluentBuilder::set_instance_name):<br>required: **true**<br><p>The name of the instance for which to update metadata parameters.</p><br>
    ///   - [`http_tokens(HttpTokens)`](crate::operation::update_instance_metadata_options::builders::UpdateInstanceMetadataOptionsFluentBuilder::http_tokens) / [`set_http_tokens(Option<HttpTokens>)`](crate::operation::update_instance_metadata_options::builders::UpdateInstanceMetadataOptionsFluentBuilder::set_http_tokens):<br>required: **false**<br><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><br>
    ///   - [`http_endpoint(HttpEndpoint)`](crate::operation::update_instance_metadata_options::builders::UpdateInstanceMetadataOptionsFluentBuilder::http_endpoint) / [`set_http_endpoint(Option<HttpEndpoint>)`](crate::operation::update_instance_metadata_options::builders::UpdateInstanceMetadataOptionsFluentBuilder::set_http_endpoint):<br>required: **false**<br><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><br>
    ///   - [`http_put_response_hop_limit(i32)`](crate::operation::update_instance_metadata_options::builders::UpdateInstanceMetadataOptionsFluentBuilder::http_put_response_hop_limit) / [`set_http_put_response_hop_limit(Option<i32>)`](crate::operation::update_instance_metadata_options::builders::UpdateInstanceMetadataOptionsFluentBuilder::set_http_put_response_hop_limit):<br>required: **false**<br><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><br>
    ///   - [`http_protocol_ipv6(HttpProtocolIpv6)`](crate::operation::update_instance_metadata_options::builders::UpdateInstanceMetadataOptionsFluentBuilder::http_protocol_ipv6) / [`set_http_protocol_ipv6(Option<HttpProtocolIpv6>)`](crate::operation::update_instance_metadata_options::builders::UpdateInstanceMetadataOptionsFluentBuilder::set_http_protocol_ipv6):<br>required: **false**<br><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><br>
    /// - On success, responds with [`UpdateInstanceMetadataOptionsOutput`](crate::operation::update_instance_metadata_options::UpdateInstanceMetadataOptionsOutput) with field(s):
    ///   - [`operation(Option<Operation>)`](crate::operation::update_instance_metadata_options::UpdateInstanceMetadataOptionsOutput::operation): <p>An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.</p>
    /// - On failure, responds with [`SdkError<UpdateInstanceMetadataOptionsError>`](crate::operation::update_instance_metadata_options::UpdateInstanceMetadataOptionsError)
    pub fn update_instance_metadata_options(
        &self,
    ) -> crate::operation::update_instance_metadata_options::builders::UpdateInstanceMetadataOptionsFluentBuilder {
        crate::operation::update_instance_metadata_options::builders::UpdateInstanceMetadataOptionsFluentBuilder::new(self.handle.clone())
    }
}