Enum vector::aws::auth::AwsAuthentication

pub enum AwsAuthentication {
    AccessKey {
        access_key_id: SensitiveString,
        secret_access_key: SensitiveString,
        assume_role: Option<String>,
        external_id: Option<String>,
        region: Option<String>,
    },
    File {
        credentials_file: String,
        profile: String,
    },
    Role {
        assume_role: String,
        external_id: Option<String>,
        load_timeout_secs: Option<u64>,
        imds: ImdsAuthentication,
        region: Option<String>,
    },
    Default {
        load_timeout_secs: Option<u64>,
        imds: ImdsAuthentication,
        region: Option<String>,
    },
}

Configuration of the authentication strategy for interacting with AWS services.

Variants

AccessKey

Authenticate using a fixed access key and secret pair.

Fields

access_key_id: SensitiveString

The AWS access key ID.

secret_access_key: SensitiveString

The AWS secret access key.

assume_role: Option<String>

The ARN of an IAM role to assume.

external_id: Option<String>

The optional unique external ID in conjunction with role to assume.

region: Option<String>

The AWS region to send STS requests to.

If not set, this will default to the configured region for the service itself.

File

Authenticate using credentials stored in a file.

Additionally, the specific credential profile to use can be set. The file format must match the credentials file format outlined in https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html.

Fields

credentials_file: String

Path to the credentials file.

profile: String

The credentials profile to use.

Used to select AWS credentials from a provided credentials file.

Role

Assume the given role ARN.

Fields

assume_role: String

The ARN of an IAM role to assume.

external_id: Option<String>

The optional unique external ID in conjunction with role to assume.

load_timeout_secs: Option<u64>

Timeout for assuming the role, in seconds.

Relevant when the default credentials chain or assume_role is used.

imds: ImdsAuthentication

Configuration for authenticating with AWS through IMDS.

region: Option<String>

The AWS region to send STS requests to.

If not set, this defaults to the configured region for the service itself.

Default

Default authentication strategy which tries a variety of substrategies in sequential order.

Fields

load_timeout_secs: Option<u64>

Timeout for successfully loading any credentials, in seconds.

Relevant when the default credentials chain or assume_role is used.

imds: ImdsAuthentication

Configuration for authenticating with AWS through IMDS.

region: Option<String>

The AWS region to send STS requests to.

If not set, this defaults to the configured region for the service itself.

Implementations

impl AwsAuthentication

pub async fn credentials_provider( &self, service_region: Region, proxy: &ProxyConfig, tls_options: &Option<TlsConfig>, ) -> Result<SharedCredentialsProvider>

Returns the provider for the credentials based on the authentication mechanism chosen.

Trait Implementations

impl Clone for AwsAuthentication

fn clone(&self) -> AwsAuthentication

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configurable for AwsAuthentication

fn referenceable_name() -> Option<&'static str>

Gets the referenceable name of this value, if any.

fn metadata() -> Metadata

Gets the metadata for this value.

fn generate_schema( schema_gen: &RefCell<SchemaGenerator>, ) -> Result<SchemaObject, GenerateError>

Generates the schema for this value.

fn is_optional() -> bool

where Self: Sized,

Whether or not this value is optional.

fn validate_metadata(_metadata: &Metadata) -> Result<(), GenerateError>

where Self: Sized,

Validates the given metadata against this type.

fn as_configurable_ref() -> ConfigurableRef

where Self: Sized + 'static,

Create a new configurable reference table.

impl Debug for AwsAuthentication

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

Formats the value using the given formatter.

impl Default for AwsAuthentication

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AwsAuthentication

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AwsAuthentication

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToValue for AwsAuthentication

fn to_value(&self) -> Value

Convert this value into a serde_json::Value. Must not fail.