Enum KinesisCredentials 

pub enum KinesisCredentials {
    Default,
    Profile {
        name: String,
    },
    AccessKey {
        access_key_id: String,
        secret_access_key: String,
        session_token: Option<String>,
    },
    AssumeRole {
        role_arn: String,
        session_name: Option<String>,
        external_id: Option<String>,
    },
    WebIdentity,
}

Available on crate features source-kinesis and source-rest only.

How to authenticate with AWS Kinesis.

Serializes as { type: <method>, config: { … } } (adjacent tagging, snake_case discriminators) — the consistent auth wire shape shared by every faucet connector.

Variants

Default

The AWS SDK default provider chain: environment variables, shared config/credentials files, ECS/EKS container credentials, web-identity tokens (AWS_WEB_IDENTITY_TOKEN_FILE / EKS IRSA), and EC2 instance profiles — with automatic refresh/rotation.

Profile

A named profile from the shared AWS config/credentials files.

Fields

name: String

Profile name (as in ~/.aws/credentials).

AccessKey

Static access keys. Prefer ${env:…} / secrets-manager interpolation over literals in config files.

Fields

access_key_id: String

AWS access key id.

secret_access_key: String

AWS secret access key.

session_token: Option<String>

Optional session token (for temporary credentials).

AssumeRole

Assume an IAM role via STS on top of the default provider chain.

Fields

role_arn: String

ARN of the role to assume.

session_name: Option<String>

Session name recorded in CloudTrail. Defaults to faucet-stream.

external_id: Option<String>

Optional external id for cross-account trust policies.

WebIdentity

Web-identity federation (e.g. EKS IRSA). Equivalent to the default chain, which honors AWS_WEB_IDENTITY_TOKEN_FILE + AWS_ROLE_ARN — kept as an explicit variant so intent is visible in configs.

Trait Implementations

impl Clone for KinesisCredentials

fn clone(&self) -> KinesisCredentials

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KinesisCredentials

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

Formats the value using the given formatter.

impl Default for KinesisCredentials

fn default() -> KinesisCredentials

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for KinesisCredentials

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for KinesisCredentials

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for KinesisCredentials

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

where __S: Serializer,

Serialize this value into the given Serde serializer.