Struct aws_sdk_ec2::input::modify_instance_metadata_options_input::Builder

pub struct Builder { /* private fields */ }

A builder for ModifyInstanceMetadataOptionsInput.

Implementations

impl Builder

pub fn instance_id(self, input: impl Into<String>) -> Self

The ID of the instance.

Examples found in repository

src/client.rs (line 65553)

        pub fn instance_id(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.instance_id(input.into());
            self
        }

pub fn set_instance_id(self, input: Option<String>) -> Self

The ID of the instance.

Examples found in repository

src/client.rs (line 65558)

        pub fn set_instance_id(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_instance_id(input);
            self
        }

pub fn http_tokens(self, input: HttpTokensState) -> Self

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 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.

Examples found in repository

src/client.rs (line 65565)

        pub fn http_tokens(mut self, input: crate::model::HttpTokensState) -> Self {
            self.inner = self.inner.http_tokens(input);
            self
        }

pub fn set_http_tokens(self, input: Option<HttpTokensState>) -> Self

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 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.

Examples found in repository

src/client.rs (line 65575)

        pub fn set_http_tokens(
            mut self,
            input: std::option::Option<crate::model::HttpTokensState>,
        ) -> Self {
            self.inner = self.inner.set_http_tokens(input);
            self
        }

pub fn http_put_response_hop_limit(self, input: i32) -> Self

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

Possible values: Integers from 1 to 64

Examples found in repository

src/client.rs (line 65581)

        pub fn http_put_response_hop_limit(mut self, input: i32) -> Self {
            self.inner = self.inner.http_put_response_hop_limit(input);
            self
        }

pub fn set_http_put_response_hop_limit(self, input: Option<i32>) -> Self

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

Possible values: Integers from 1 to 64

Examples found in repository

src/client.rs (line 65587)

        pub fn set_http_put_response_hop_limit(mut self, input: std::option::Option<i32>) -> Self {
            self.inner = self.inner.set_http_put_response_hop_limit(input);
            self
        }

pub fn http_endpoint(self, input: InstanceMetadataEndpointState) -> Self

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.

Examples found in repository

src/client.rs (line 65593)

        pub fn http_endpoint(mut self, input: crate::model::InstanceMetadataEndpointState) -> Self {
            self.inner = self.inner.http_endpoint(input);
            self
        }

pub fn set_http_endpoint(
    self,
    input: Option<InstanceMetadataEndpointState>
) -> Self

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.

Examples found in repository

src/client.rs (line 65602)

        pub fn set_http_endpoint(
            mut self,
            input: std::option::Option<crate::model::InstanceMetadataEndpointState>,
        ) -> Self {
            self.inner = self.inner.set_http_endpoint(input);
            self
        }

pub fn dry_run(self, input: bool) -> Self

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Examples found in repository

src/client.rs (line 65607)

        pub fn dry_run(mut self, input: bool) -> Self {
            self.inner = self.inner.dry_run(input);
            self
        }

pub fn set_dry_run(self, input: Option<bool>) -> Self

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Examples found in repository

src/client.rs (line 65612)

        pub fn set_dry_run(mut self, input: std::option::Option<bool>) -> Self {
            self.inner = self.inner.set_dry_run(input);
            self
        }

pub fn http_protocol_ipv6(self, input: InstanceMetadataProtocolState) -> Self

Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only if you have enabled the HTTP metadata endpoint.

Examples found in repository

src/client.rs (line 65620)

        pub fn http_protocol_ipv6(
            mut self,
            input: crate::model::InstanceMetadataProtocolState,
        ) -> Self {
            self.inner = self.inner.http_protocol_ipv6(input);
            self
        }

pub fn set_http_protocol_ipv6(
    self,
    input: Option<InstanceMetadataProtocolState>
) -> Self

Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only if you have enabled the HTTP metadata endpoint.

Examples found in repository

src/client.rs (line 65628)

        pub fn set_http_protocol_ipv6(
            mut self,
            input: std::option::Option<crate::model::InstanceMetadataProtocolState>,
        ) -> Self {
            self.inner = self.inner.set_http_protocol_ipv6(input);
            self
        }

pub fn instance_metadata_tags(self, input: InstanceMetadataTagsState) -> Self

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

Examples found in repository

src/client.rs (line 65637)

        pub fn instance_metadata_tags(
            mut self,
            input: crate::model::InstanceMetadataTagsState,
        ) -> Self {
            self.inner = self.inner.instance_metadata_tags(input);
            self
        }

pub fn set_instance_metadata_tags(
    self,
    input: Option<InstanceMetadataTagsState>
) -> Self

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

Examples found in repository

src/client.rs (line 65646)

        pub fn set_instance_metadata_tags(
            mut self,
            input: std::option::Option<crate::model::InstanceMetadataTagsState>,
        ) -> Self {
            self.inner = self.inner.set_instance_metadata_tags(input);
            self
        }

pub fn build(self) -> Result<ModifyInstanceMetadataOptionsInput, BuildError>

Consumes the builder and constructs a ModifyInstanceMetadataOptionsInput.

Examples found in repository

src/client.rs (line 65520)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::ModifyInstanceMetadataOptions,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::ModifyInstanceMetadataOptionsError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// Sends the request and returns the response.
        ///
        /// If an error occurs, an `SdkError` will be returned with additional details that
        /// can be matched against.
        ///
        /// By default, any retryable failures will be retried twice. Retry behavior
        /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
        /// set when configuring the client.
        pub async fn send(
            self,
        ) -> std::result::Result<
            crate::output::ModifyInstanceMetadataOptionsOutput,
            aws_smithy_http::result::SdkError<crate::error::ModifyInstanceMetadataOptionsError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Builder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Builder