Struct ExecuteStatementInput

#[non_exhaustive]
pub struct ExecuteStatementInput {

    pub sql: Option<String>,
    pub cluster_identifier: Option<String>,
    pub secret_arn: Option<String>,
    pub db_user: Option<String>,
    pub database: Option<String>,
    pub with_event: Option<bool>,
    pub statement_name: Option<String>,
    pub parameters: Option<Vec<SqlParameter>>,
    pub workgroup_name: Option<String>,
    pub client_token: Option<String>,
    pub session_keep_alive_seconds: Option<i32>,
    pub session_id: Option<String>,
    pub result_format: Option<ResultFormatString>,
}

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.

sql: Option<String>

The SQL statement text to run.

cluster_identifier: Option<String>

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

secret_arn: Option<String>

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

db_user: Option<String>

The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.

database: Option<String>

The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

with_event: Option<bool>

A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs.

statement_name: Option<String>

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

parameters: Option<Vec<SqlParameter>>

The parameters for the SQL statement.

workgroup_name: Option<String>

The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

client_token: Option<String>

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

session_keep_alive_seconds: Option<i32>

The number of seconds to keep the session alive after the query finishes. The maximum time a session can keep alive is 24 hours. After 24 hours, the session is forced closed and the query is terminated.

session_id: Option<String>

The session identifier of the query.

result_format: Option<ResultFormatString>

The data format of the result of the SQL statement. If no format is specified, the default is JSON.

Implementations

impl ExecuteStatementInput

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

The SQL statement text to run.

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

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

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

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

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

The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.

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

The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

pub fn with_event(&self) -> Option<bool>

A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs.

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 parameters(&self) -> &[SqlParameter]

The parameters for the SQL statement.

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

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

The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

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

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

pub fn session_keep_alive_seconds(&self) -> Option<i32>

The number of seconds to keep the session alive after the query finishes. The maximum time a session can keep alive is 24 hours. After 24 hours, the session is forced closed and the query is terminated.

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

The session identifier of the query.

pub fn result_format(&self) -> Option<&ResultFormatString>

The data format of the result of the SQL statement. If no format is specified, the default is JSON.

impl ExecuteStatementInput

pub fn builder() -> ExecuteStatementInputBuilder

Creates a new builder-style object to manufacture ExecuteStatementInput.

Trait Implementations

impl Clone for ExecuteStatementInput

fn clone(&self) -> ExecuteStatementInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExecuteStatementInput

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

Formats the value using the given formatter.

impl PartialEq for ExecuteStatementInput

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

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

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 ExecuteStatementInput