Struct ECSCredentialProvider 

pub struct ECSCredentialProvider { /* private fields */ }

ECS Task Role Credentials Provider

This provider fetches IAM credentials from the ECS Task IAM Roles endpoint. It supports both relative URI (ECS) and full URI (Fargate) modes.

Important Note

This provider fetches IAM credentials, not task metadata. The credentials endpoint is separate from the task metadata endpoints (v2/v3/v4). While metadata endpoints provide information about the task and container, the credentials endpoint provides IAM role credentials for authentication.

Configuration

Configuration values can be provided directly via builder methods or through environment variables. Direct configuration takes precedence over environment variables.

Builder Methods

• ECSCredentialProvider::with_relative_uri: Set the relative URI for ECS environments
• ECSCredentialProvider::with_endpoint: Set a complete custom endpoint URL (for Fargate or custom setups)
• ECSCredentialProvider::with_auth_token: Set the authorization token directly
• ECSCredentialProvider::with_auth_token_file: Set the path to the authorization token file
• ECSCredentialProvider::with_metadata_uri_override: Override the base metadata endpoint for relative URIs

Environment Variables (Fallback)

• AWS_CONTAINER_CREDENTIALS_RELATIVE_URI: Relative URI to fetch credentials (ECS)
• AWS_CONTAINER_CREDENTIALS_FULL_URI: Full URI to fetch credentials (Fargate)
• AWS_CONTAINER_AUTHORIZATION_TOKEN: Authorization token for the request
• AWS_CONTAINER_AUTHORIZATION_TOKEN_FILE: File containing the authorization token
• ECS_CONTAINER_METADATA_URI: Override the default base endpoint (for testing)

Examples

use reqsign_aws_core::ECSCredentialProvider;

// Configure for ECS with relative URI
let provider = ECSCredentialProvider::new()
    .with_relative_uri("/v2/credentials/task-role")
    .with_auth_token("my-auth-token");

// Configure for Fargate with full endpoint
let provider = ECSCredentialProvider::new()
    .with_endpoint("http://169.254.170.2/v2/credentials/task-role")
    .with_auth_token_file("/tmp/auth-token");

Implementations

impl ECSCredentialProvider

pub fn new() -> Self

Create a new ECS credential provider

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

Create with custom endpoint

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

Create with custom auth token

pub fn with_auth_token_file(self, file_path: impl Into<String>) -> Self

Create with custom auth token file path

pub fn with_relative_uri(self, uri: impl Into<String>) -> Self

Create with container credentials relative URI This is used in ECS environments where the base metadata URI is known

pub fn with_metadata_uri_override(self, uri: impl Into<String>) -> Self

Override the metadata URI base endpoint (typically for testing) Defaults to http://169.254.170.2 if not specified

Trait Implementations

impl Clone for ECSCredentialProvider

fn clone(&self) -> ECSCredentialProvider

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ECSCredentialProvider

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

Formats the value using the given formatter.

impl Default for ECSCredentialProvider

fn default() -> Self

Returns the “default value” for a type.

impl ProvideCredential for ECSCredentialProvider

type Credential = Credential

Credential returned by this loader.

async fn provide_credential( &self, ctx: &Context, ) -> Result<Option<Self::Credential>>

Load signing credential from current env.