Skip to main content

AwsCredentials

Enum AwsCredentials 

Source
pub enum AwsCredentials {
    AccessKeys {
        access_key_id: String,
        secret_access_key: String,
        session_token: Option<String>,
    },
    SessionCredentials {
        access_key_id: String,
        expires_at: String,
        secret_access_key: String,
        session_token: String,
    },
    Imds {
        endpoint: Option<String>,
    },
    Profile {
        name: String,
    },
    WebIdentity {
        config: AwsWebIdentityConfig,
    },
}
Expand description

Supported AWS authentication methods

JSON schema
{
 "description": "Supported AWS authentication methods",
 "oneOf": [
   {
     "description": "Static direct access keys.",
     "type": "object",
     "required": [
       "access_key_id",
       "secret_access_key",
       "type"
     ],
     "properties": {
       "access_key_id": {
         "description": "AWS Access Key ID",
         "type": "string"
       },
       "secret_access_key": {
         "description": "AWS Secret Access Key",
         "type": "string"
       },
       "session_token": {
         "description": "Optional AWS Session Token",
         "type": [
           "string",
           "null"
         ]
       },
       "type": {
         "type": "string",
         "enum": [
           "accessKeys"
         ]
       }
     }
   },
   {
     "description": "Temporary AWS session credentials with an expiration time.",
     "type": "object",
     "required": [
       "access_key_id",
       "expires_at",
       "secret_access_key",
       "session_token",
       "type"
     ],
     "properties": {
       "access_key_id": {
         "description": "AWS Access Key ID",
         "type": "string"
       },
       "expires_at": {
         "description": "Credential expiration as an RFC3339 timestamp",
         "type": "string"
       },
       "secret_access_key": {
         "description": "AWS Secret Access Key",
         "type": "string"
       },
       "session_token": {
         "description": "AWS Session Token",
         "type": "string"
       },
       "type": {
         "type": "string",
         "enum": [
           "sessionCredentials"
         ]
       }
     }
   },
   {
     "description": "AWS Instance Metadata Service credentials.",
     "type": "object",
     "required": [
       "type"
     ],
     "properties": {
       "endpoint": {
         "description": "Optional IMDS endpoint override",
         "type": [
           "string",
           "null"
         ]
       },
       "type": {
         "type": "string",
         "enum": [
           "imds"
         ]
       }
     }
   },
   {
     "description": "AWS profile credentials loaded via the AWS CLI.",
     "type": "object",
     "required": [
       "name",
       "type"
     ],
     "properties": {
       "name": {
         "description": "AWS profile name",
         "type": "string"
       },
       "type": {
         "type": "string",
         "enum": [
           "profile"
         ]
       }
     }
   },
   {
     "description": "Web Identity Token for OIDC authentication",
     "type": "object",
     "required": [
       "config",
       "type"
     ],
     "properties": {
       "config": {
         "$ref": "#/components/schemas/AwsWebIdentityConfig"
       },
       "type": {
         "type": "string",
         "enum": [
           "webIdentity"
         ]
       }
     }
   }
 ]
}

Variants§

§

AccessKeys

Static direct access keys.

Fields

§access_key_id: String

AWS Access Key ID

§secret_access_key: String

AWS Secret Access Key

§session_token: Option<String>

Optional AWS Session Token

§

SessionCredentials

Temporary AWS session credentials with an expiration time.

Fields

§access_key_id: String

AWS Access Key ID

§expires_at: String

Credential expiration as an RFC3339 timestamp

§secret_access_key: String

AWS Secret Access Key

§session_token: String

AWS Session Token

§

Imds

AWS Instance Metadata Service credentials.

Fields

§endpoint: Option<String>

Optional IMDS endpoint override

§

Profile

AWS profile credentials loaded via the AWS CLI.

Fields

§name: String

AWS profile name

§

WebIdentity

Web Identity Token for OIDC authentication

Trait Implementations§

Source§

impl Clone for AwsCredentials

Source§

fn clone(&self) -> AwsCredentials

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AwsCredentials

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for AwsCredentials

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<&AwsCredentials> for AwsCredentials

Source§

fn from(value: &AwsCredentials) -> Self

Converts to this type from the input type.
Source§

impl Serialize for AwsCredentials

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more