Struct AmazonBuilder 

pub struct AmazonBuilder { /* private fields */ }

Configure AWS authentication credentials.

Example

let config = AmazonBuilder::new()
 .with_region(REGION)
 .with_access_key_id(ACCESS_KEY_ID)
 .with_secret_access_key(SECRET_KEY)
 .build(None);

Implementations

impl AmazonBuilder

pub fn new() -> Self

Create a new AmazonBuilder with default values.

pub fn from_env() -> Self

Fill the AmazonBuilder with regular AWS environment variables

Variables extracted from environment:

• AWS_ACCESS_KEY_ID -> access_key_id
• AWS_SECRET_ACCESS_KEY -> secret_access_key
• AWS_DEFAULT_REGION -> region
• AWS_SESSION_TOKEN -> token
• AWS_CONTAINER_CREDENTIALS_RELATIVE_URI -> https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html
• AWS_ALLOW_HTTP -> set to “true” to permit HTTP connections without TLS

pub fn with_config( self, key: AmazonS3ConfigKey, value: impl Into<String>, ) -> Self

Set an option on the builder via a key - value pair.

pub fn get_config_value(&self, key: &AmazonS3ConfigKey) -> Option<String>

Get config value via a AmazonS3ConfigKey.

pub fn with_access_key_id(self, access_key_id: impl Into<String>) -> Self

Set the AWS Access Key

pub fn with_secret_access_key( self, secret_access_key: impl Into<String>, ) -> Self

Set the AWS Secret Access Key

pub fn with_token(self, token: impl Into<String>) -> Self

Set the AWS Session Token to use for requests

pub fn with_region(self, region: impl Into<String>) -> Self

Set the region, defaults to us-east-1

pub fn with_credentials(self, credentials: AwsCredentialProvider) -> Self

Set the credential provider overriding any other options

pub fn with_allow_http(self, allow_http: bool) -> Self

Sets what protocol is allowed. If allow_http is :

• false (default): Only HTTPS are allowed
• true: HTTP and HTTPS are allowed

pub fn with_retry(self, retry_config: RetryConfig) -> Self

Set the retry configuration

pub fn with_imdsv1_fallback(self) -> Self

By default instance credentials will only be fetched over IMDSv2, as AWS recommends against having IMDSv1 enabled on EC2 instances as it is vulnerable to SSRF attack

However, certain deployment environments, such as those running old versions of kube2iam, may not support IMDSv2. This option will enable automatic fallback to using IMDSv1 if the token endpoint returns a 403 error indicating that IMDSv2 is not supported.

pub fn with_skip_signature(self, skip_signature: bool) -> Self

If enabled, requests will not be signed.

pub fn with_metadata_endpoint(self, endpoint: impl Into<String>) -> Self

Set the instance metadata endpoint, used primarily within AWS EC2.

This defaults to the IPv4 endpoint: http://169.254.169.254. One can alternatively use the IPv6 endpoint http://fd00:ec2::254.

pub fn with_role_arn(self, role_arn: impl Into<String>) -> Self

Assume the given IAM role via STS AssumeRole after obtaining base credentials.

When set, the builder resolves base credentials (static, IMDS, or WebIdentity) and then exchanges them for temporary credentials scoped to role_arn.

References

• https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html

pub fn with_role_session_name(self, session_name: impl Into<String>) -> Self

Set the session name used in AssumeRole requests (defaults to "AssumeRoleSession").

pub fn with_sts_endpoint(self, endpoint: impl Into<String>) -> Self

Override the STS endpoint used for AssumeRole (defaults to the regional endpoint).

pub fn with_proxy_url(self, proxy_url: impl Into<String>) -> Self

Set the proxy_url to be used by the underlying client

pub fn with_proxy_ca_certificate( self, proxy_ca_certificate: impl Into<String>, ) -> Self

Set a trusted proxy CA certificate

pub fn with_proxy_excludes(self, proxy_excludes: impl Into<String>) -> Self

Set a list of hosts to exclude from proxy connections

pub fn with_client_options(self, options: ClientOptions) -> Self

Sets the client options, overriding any already set

pub fn build(self, runtime: Option<&Handle>) -> Result<AmazonConfig>

Build an AmazonConfig from the provided values, consuming self.

If runtime is provided, all HTTP I/O (including credential refresh) will be spawned on the given runtime handle.

Trait Implementations

impl Clone for AmazonBuilder

fn clone(&self) -> AmazonBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AmazonBuilder

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

Formats the value using the given formatter.

impl Default for AmazonBuilder

fn default() -> AmazonBuilder

Returns the “default value” for a type.