Struct Builder

pub struct Builder { /* private fields */ }

IMDSv2 Client Builder

Implementations

impl Builder

pub fn max_attempts(self, max_attempts: u32) -> Self

Override the number of retries for fetching tokens & metadata

By default, 4 attempts will be made.

pub fn configure(self, provider_config: &ProviderConfig) -> Self

Configure generic options of the Client

Examples

use aws_config::imds::Client;
use aws_config::provider_config::ProviderConfig;

let provider = Client::builder()
    .configure(&ProviderConfig::with_default_region().await)
    .build();

pub fn endpoint(self, endpoint: impl AsRef<str>) -> Result<Self, BoxError>

Override the endpoint for the Client

By default, the client will resolve an endpoint from the environment, AWS config, and endpoint mode.

See Client for more information.

pub fn endpoint_mode(self, mode: EndpointMode) -> Self

Override the endpoint mode for Client

• When set to IpV4, the endpoint will be http://169.254.169.254.
• When set to IpV6, the endpoint will be http://[fd00:ec2::254].

pub fn token_ttl(self, ttl: Duration) -> Self

Override the time-to-live for the session token

Requests to IMDS utilize a session token for authentication. By default, session tokens last for 6 hours. When the TTL for the token expires, a new token must be retrieved from the metadata service.

pub fn connect_timeout(self, timeout: Duration) -> Self

Override the connect timeout for IMDS

This value defaults to 1 second

pub fn read_timeout(self, timeout: Duration) -> Self

Override the read timeout for IMDS

This value defaults to 1 second

pub fn build(self) -> Client

Build an IMDSv2 Client

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.