Enum RedshiftCredentials 

pub enum RedshiftCredentials {
    Password {
        password: String,
    },
    Iam {
        region: Option<String>,
        cluster_identifier: Option<String>,
        db_user: Option<String>,
        workgroup_name: Option<String>,
        auto_create: bool,
        db_groups: Vec<String>,
        duration_secs: Option<u32>,
        aws_credentials: RedshiftAwsCredentials,
        endpoint_url: Option<String>,
    },
    RedshiftDataApi {
        region: Option<String>,
        cluster_identifier: Option<String>,
        workgroup_name: Option<String>,
        secret_arn: Option<String>,
        db_user: Option<String>,
        aws_credentials: RedshiftAwsCredentials,
        endpoint_url: Option<String>,
    },
}

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.

• Password — a database user and password over the PostgreSQL wire protocol.
• Iam — temporary database credentials from redshift:GetClusterCredentials (provisioned cluster) or redshift-serverless:GetCredentials (workgroup), refreshed before they expire, over the PostgreSQL wire protocol.
• RedshiftDataApi — every statement runs through the Redshift Data API over HTTPS; no network path to the cluster is needed.

Variants

Password

Username/password authentication (the user comes from RedshiftConnection::user).

Fields

password: String

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

Iam

IAM authentication with temporary database credentials. Set exactly one of cluster_identifier (provisioned, GetClusterCredentials) or workgroup_name (serverless, GetCredentials). The connection then uses the returned user and password over the PostgreSQL wire protocol (host, port, database and TLS as configured), and new pool connections get fresh credentials before the old ones expire.

Fields

region: Option<String>

AWS region of the cluster or workgroup. None uses the SDK default chain (AWS_REGION, profile).

cluster_identifier: Option<String>

Provisioned cluster identifier (GetClusterCredentials).

db_user: Option<String>

Database user to request credentials for (provisioned only). Defaults to RedshiftConnection::user.

workgroup_name: Option<String>

Serverless workgroup name (redshift-serverless:GetCredentials); the database user is derived from the IAM identity.

auto_create: bool

Create db_user when it does not exist (provisioned only).

db_groups: Vec<String>

Database groups the user joins for the session (provisioned only).

duration_secs: Option<u32>

Lifetime of the temporary credentials, 900–3600 seconds. None uses the service default (900).

aws_credentials: RedshiftAwsCredentials

AWS credentials used to call the credentials API. Defaults to the SDK default chain.

endpoint_url: Option<String>

Endpoint override for the credentials API (VPC endpoints, tests).

RedshiftDataApi

Every statement runs through the Redshift Data API over HTTPS (ExecuteStatement, DescribeStatement, GetStatementResult), not the PostgreSQL wire protocol, so host, port, user and the TLS settings are not used. Set exactly one of cluster_identifier or workgroup_name; a cluster also needs db_user (temporary credentials) or secret_arn.

Fields

region: Option<String>

AWS region. None uses the SDK default chain.

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 with temporary credentials (provisioned clusters only).

aws_credentials: RedshiftAwsCredentials

AWS credentials used to call the Data API. Defaults to the SDK default chain.

endpoint_url: Option<String>

Endpoint override for the Data API (VPC endpoints, tests).

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.