Enum RedshiftCredentials 

pub enum RedshiftCredentials {
    Password {
        password: String,
    },
    Iam {
        region: Option<String>,
        cluster_identifier: Option<String>,
        db_user: Option<String>,
    },
    RedshiftDataApi {
        region: Option<String>,
        cluster_identifier: Option<String>,
        workgroup_name: Option<String>,
        secret_arn: Option<String>,
        db_user: Option<String>,
    },
}

Available on crate feature sink-redshift only.

How to authenticate with Amazon Redshift.

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

v1 implements only RedshiftCredentials::Password. The Iam and RedshiftDataApi variants are accepted by the config parser (so a future version can add them without a breaking change) but currently return a typed FaucetError::Config at client-build time.

Variants

Password

Username/password authentication (the user comes from RedshiftConnection::user). The only mechanism supported in v1.

Fields

password: String

The password (use ${env:…} / ${vault:…} to inject it, never a literal).

Iam

IAM authentication via temporary cluster credentials (GetClusterCredentials). Not yet supported — reserved for a future version; building a client with this variant returns a typed error.

Fields

region: Option<String>

AWS region of the cluster.

cluster_identifier: Option<String>

Provisioned cluster identifier used to request temporary credentials.

db_user: Option<String>

Database user to authenticate as.

RedshiftDataApi

Authentication through the Redshift Data API (HTTP, not the PG wire). Not yet supported — reserved for a future version; building a client with this variant returns a typed error.

Fields

region: Option<String>

AWS region.

cluster_identifier: Option<String>

Provisioned cluster identifier.

workgroup_name: Option<String>

Serverless workgroup name (alternative to cluster_identifier).

secret_arn: Option<String>

Secrets Manager ARN holding the database credentials.

db_user: Option<String>

Database user to authenticate as.

Trait Implementations

impl Clone for RedshiftCredentials

fn clone(&self) -> RedshiftCredentials

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RedshiftCredentials

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RedshiftCredentials

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for RedshiftCredentials

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 RedshiftCredentials

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.