Struct RedshiftDataParameters

#[non_exhaustive]
pub struct RedshiftDataParameters {
    pub secret_manager_arn: Option<String>,
    pub database: String,
    pub db_user: Option<String>,
    pub sql: Option<String>,
    pub statement_name: Option<String>,
    pub with_event: bool,
    pub sqls: Option<Vec<String>>,
}

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

secret_manager_arn: Option<String>

The name or ARN of the secret that enables access to the database. Required when authenticating using Amazon Web Services Secrets Manager.

database: String

The name of the database. Required when authenticating using temporary credentials.

db_user: Option<String>

The database user name. Required when authenticating using temporary credentials.

sql: Option<String>

The SQL statement text to run.

statement_name: Option<String>

The name of the SQL statement. You can name the SQL statement when you create it to identify the query.

with_event: bool

Indicates whether to send an event back to EventBridge after the SQL statement runs.

sqls: Option<Vec<String>>

One or more SQL statements to run. The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back.

Implementations

impl RedshiftDataParameters

pub fn secret_manager_arn(&self) -> Option<&str>

The name or ARN of the secret that enables access to the database. Required when authenticating using Amazon Web Services Secrets Manager.

pub fn database(&self) -> &str

The name of the database. Required when authenticating using temporary credentials.

pub fn db_user(&self) -> Option<&str>

The database user name. Required when authenticating using temporary credentials.

pub fn sql(&self) -> Option<&str>

The SQL statement text to run.

pub fn statement_name(&self) -> Option<&str>

The name of the SQL statement. You can name the SQL statement when you create it to identify the query.

pub fn with_event(&self) -> bool

Indicates whether to send an event back to EventBridge after the SQL statement runs.

pub fn sqls(&self) -> &[String]

One or more SQL statements to run. The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .sqls.is_none().

impl RedshiftDataParameters

pub fn builder() -> RedshiftDataParametersBuilder

Creates a new builder-style object to manufacture RedshiftDataParameters.

Trait Implementations

impl Clone for RedshiftDataParameters

fn clone(&self) -> RedshiftDataParameters

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RedshiftDataParameters

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

Formats the value using the given formatter.

impl PartialEq for RedshiftDataParameters

fn eq(&self, other: &RedshiftDataParameters) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RedshiftDataParameters