AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::EventBridge::Model::RedshiftDataParameters Class Reference

#include <RedshiftDataParameters.h>

Public Member Functions

 RedshiftDataParameters ()
 
 RedshiftDataParameters (Aws::Utils::Json::JsonView jsonValue)
 
RedshiftDataParametersoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetSecretManagerArn () const
 
bool SecretManagerArnHasBeenSet () const
 
void SetSecretManagerArn (const Aws::String &value)
 
void SetSecretManagerArn (Aws::String &&value)
 
void SetSecretManagerArn (const char *value)
 
RedshiftDataParametersWithSecretManagerArn (const Aws::String &value)
 
RedshiftDataParametersWithSecretManagerArn (Aws::String &&value)
 
RedshiftDataParametersWithSecretManagerArn (const char *value)
 
const Aws::StringGetDatabase () const
 
bool DatabaseHasBeenSet () const
 
void SetDatabase (const Aws::String &value)
 
void SetDatabase (Aws::String &&value)
 
void SetDatabase (const char *value)
 
RedshiftDataParametersWithDatabase (const Aws::String &value)
 
RedshiftDataParametersWithDatabase (Aws::String &&value)
 
RedshiftDataParametersWithDatabase (const char *value)
 
const Aws::StringGetDbUser () const
 
bool DbUserHasBeenSet () const
 
void SetDbUser (const Aws::String &value)
 
void SetDbUser (Aws::String &&value)
 
void SetDbUser (const char *value)
 
RedshiftDataParametersWithDbUser (const Aws::String &value)
 
RedshiftDataParametersWithDbUser (Aws::String &&value)
 
RedshiftDataParametersWithDbUser (const char *value)
 
const Aws::StringGetSql () const
 
bool SqlHasBeenSet () const
 
void SetSql (const Aws::String &value)
 
void SetSql (Aws::String &&value)
 
void SetSql (const char *value)
 
RedshiftDataParametersWithSql (const Aws::String &value)
 
RedshiftDataParametersWithSql (Aws::String &&value)
 
RedshiftDataParametersWithSql (const char *value)
 
const Aws::StringGetStatementName () const
 
bool StatementNameHasBeenSet () const
 
void SetStatementName (const Aws::String &value)
 
void SetStatementName (Aws::String &&value)
 
void SetStatementName (const char *value)
 
RedshiftDataParametersWithStatementName (const Aws::String &value)
 
RedshiftDataParametersWithStatementName (Aws::String &&value)
 
RedshiftDataParametersWithStatementName (const char *value)
 
bool GetWithEvent () const
 
bool WithEventHasBeenSet () const
 
void SetWithEvent (bool value)
 
RedshiftDataParametersWithWithEvent (bool value)
 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 33 of file RedshiftDataParameters.h.

Constructor & Destructor Documentation

◆ RedshiftDataParameters() [1/2]

Aws::EventBridge::Model::RedshiftDataParameters::RedshiftDataParameters ( )

◆ RedshiftDataParameters() [2/2]

Aws::EventBridge::Model::RedshiftDataParameters::RedshiftDataParameters ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ DatabaseHasBeenSet()

bool Aws::EventBridge::Model::RedshiftDataParameters::DatabaseHasBeenSet ( ) const
inline

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

Definition at line 101 of file RedshiftDataParameters.h.

◆ DbUserHasBeenSet()

bool Aws::EventBridge::Model::RedshiftDataParameters::DbUserHasBeenSet ( ) const
inline

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

Definition at line 150 of file RedshiftDataParameters.h.

◆ GetDatabase()

const Aws::String& Aws::EventBridge::Model::RedshiftDataParameters::GetDatabase ( ) const
inline

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

Definition at line 95 of file RedshiftDataParameters.h.

◆ GetDbUser()

const Aws::String& Aws::EventBridge::Model::RedshiftDataParameters::GetDbUser ( ) const
inline

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

Definition at line 144 of file RedshiftDataParameters.h.

◆ GetSecretManagerArn()

const Aws::String& Aws::EventBridge::Model::RedshiftDataParameters::GetSecretManagerArn ( ) const
inline

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

Definition at line 46 of file RedshiftDataParameters.h.

◆ GetSql()

const Aws::String& Aws::EventBridge::Model::RedshiftDataParameters::GetSql ( ) const
inline

The SQL statement text to run.

Definition at line 192 of file RedshiftDataParameters.h.

◆ GetStatementName()

const Aws::String& Aws::EventBridge::Model::RedshiftDataParameters::GetStatementName ( ) const
inline

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

Definition at line 234 of file RedshiftDataParameters.h.

◆ GetWithEvent()

bool Aws::EventBridge::Model::RedshiftDataParameters::GetWithEvent ( ) const
inline

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

Definition at line 283 of file RedshiftDataParameters.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::EventBridge::Model::RedshiftDataParameters::Jsonize ( ) const

◆ operator=()

RedshiftDataParameters& Aws::EventBridge::Model::RedshiftDataParameters::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SecretManagerArnHasBeenSet()

bool Aws::EventBridge::Model::RedshiftDataParameters::SecretManagerArnHasBeenSet ( ) const
inline

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

Definition at line 52 of file RedshiftDataParameters.h.

◆ SetDatabase() [1/3]

void Aws::EventBridge::Model::RedshiftDataParameters::SetDatabase ( const Aws::String value)
inline

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

Definition at line 107 of file RedshiftDataParameters.h.

◆ SetDatabase() [2/3]

void Aws::EventBridge::Model::RedshiftDataParameters::SetDatabase ( Aws::String &&  value)
inline

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

Definition at line 113 of file RedshiftDataParameters.h.

◆ SetDatabase() [3/3]

void Aws::EventBridge::Model::RedshiftDataParameters::SetDatabase ( const char *  value)
inline

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

Definition at line 119 of file RedshiftDataParameters.h.

◆ SetDbUser() [1/3]

void Aws::EventBridge::Model::RedshiftDataParameters::SetDbUser ( const Aws::String value)
inline

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

Definition at line 156 of file RedshiftDataParameters.h.

◆ SetDbUser() [2/3]

void Aws::EventBridge::Model::RedshiftDataParameters::SetDbUser ( Aws::String &&  value)
inline

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

Definition at line 162 of file RedshiftDataParameters.h.

◆ SetDbUser() [3/3]

void Aws::EventBridge::Model::RedshiftDataParameters::SetDbUser ( const char *  value)
inline

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

Definition at line 168 of file RedshiftDataParameters.h.

◆ SetSecretManagerArn() [1/3]

void Aws::EventBridge::Model::RedshiftDataParameters::SetSecretManagerArn ( const Aws::String value)
inline

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

Definition at line 58 of file RedshiftDataParameters.h.

◆ SetSecretManagerArn() [2/3]

void Aws::EventBridge::Model::RedshiftDataParameters::SetSecretManagerArn ( Aws::String &&  value)
inline

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

Definition at line 64 of file RedshiftDataParameters.h.

◆ SetSecretManagerArn() [3/3]

void Aws::EventBridge::Model::RedshiftDataParameters::SetSecretManagerArn ( const char *  value)
inline

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

Definition at line 70 of file RedshiftDataParameters.h.

◆ SetSql() [1/3]

void Aws::EventBridge::Model::RedshiftDataParameters::SetSql ( const Aws::String value)
inline

The SQL statement text to run.

Definition at line 202 of file RedshiftDataParameters.h.

◆ SetSql() [2/3]

void Aws::EventBridge::Model::RedshiftDataParameters::SetSql ( Aws::String &&  value)
inline

The SQL statement text to run.

Definition at line 207 of file RedshiftDataParameters.h.

◆ SetSql() [3/3]

void Aws::EventBridge::Model::RedshiftDataParameters::SetSql ( const char *  value)
inline

The SQL statement text to run.

Definition at line 212 of file RedshiftDataParameters.h.

◆ SetStatementName() [1/3]

void Aws::EventBridge::Model::RedshiftDataParameters::SetStatementName ( const Aws::String value)
inline

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

Definition at line 246 of file RedshiftDataParameters.h.

◆ SetStatementName() [2/3]

void Aws::EventBridge::Model::RedshiftDataParameters::SetStatementName ( Aws::String &&  value)
inline

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

Definition at line 252 of file RedshiftDataParameters.h.

◆ SetStatementName() [3/3]

void Aws::EventBridge::Model::RedshiftDataParameters::SetStatementName ( const char *  value)
inline

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

Definition at line 258 of file RedshiftDataParameters.h.

◆ SetWithEvent()

void Aws::EventBridge::Model::RedshiftDataParameters::SetWithEvent ( bool  value)
inline

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

Definition at line 295 of file RedshiftDataParameters.h.

◆ SqlHasBeenSet()

bool Aws::EventBridge::Model::RedshiftDataParameters::SqlHasBeenSet ( ) const
inline

The SQL statement text to run.

Definition at line 197 of file RedshiftDataParameters.h.

◆ StatementNameHasBeenSet()

bool Aws::EventBridge::Model::RedshiftDataParameters::StatementNameHasBeenSet ( ) const
inline

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

Definition at line 240 of file RedshiftDataParameters.h.

◆ WithDatabase() [1/3]

RedshiftDataParameters& Aws::EventBridge::Model::RedshiftDataParameters::WithDatabase ( const Aws::String value)
inline

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

Definition at line 125 of file RedshiftDataParameters.h.

◆ WithDatabase() [2/3]

RedshiftDataParameters& Aws::EventBridge::Model::RedshiftDataParameters::WithDatabase ( Aws::String &&  value)
inline

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

Definition at line 131 of file RedshiftDataParameters.h.

◆ WithDatabase() [3/3]

RedshiftDataParameters& Aws::EventBridge::Model::RedshiftDataParameters::WithDatabase ( const char *  value)
inline

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

Definition at line 137 of file RedshiftDataParameters.h.

◆ WithDbUser() [1/3]

RedshiftDataParameters& Aws::EventBridge::Model::RedshiftDataParameters::WithDbUser ( const Aws::String value)
inline

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

Definition at line 174 of file RedshiftDataParameters.h.

◆ WithDbUser() [2/3]

RedshiftDataParameters& Aws::EventBridge::Model::RedshiftDataParameters::WithDbUser ( Aws::String &&  value)
inline

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

Definition at line 180 of file RedshiftDataParameters.h.

◆ WithDbUser() [3/3]

RedshiftDataParameters& Aws::EventBridge::Model::RedshiftDataParameters::WithDbUser ( const char *  value)
inline

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

Definition at line 186 of file RedshiftDataParameters.h.

◆ WithEventHasBeenSet()

bool Aws::EventBridge::Model::RedshiftDataParameters::WithEventHasBeenSet ( ) const
inline

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

Definition at line 289 of file RedshiftDataParameters.h.

◆ WithSecretManagerArn() [1/3]

RedshiftDataParameters& Aws::EventBridge::Model::RedshiftDataParameters::WithSecretManagerArn ( const Aws::String value)
inline

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

Definition at line 76 of file RedshiftDataParameters.h.

◆ WithSecretManagerArn() [2/3]

RedshiftDataParameters& Aws::EventBridge::Model::RedshiftDataParameters::WithSecretManagerArn ( Aws::String &&  value)
inline

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

Definition at line 82 of file RedshiftDataParameters.h.

◆ WithSecretManagerArn() [3/3]

RedshiftDataParameters& Aws::EventBridge::Model::RedshiftDataParameters::WithSecretManagerArn ( const char *  value)
inline

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

Definition at line 88 of file RedshiftDataParameters.h.

◆ WithSql() [1/3]

RedshiftDataParameters& Aws::EventBridge::Model::RedshiftDataParameters::WithSql ( const Aws::String value)
inline

The SQL statement text to run.

Definition at line 217 of file RedshiftDataParameters.h.

◆ WithSql() [2/3]

RedshiftDataParameters& Aws::EventBridge::Model::RedshiftDataParameters::WithSql ( Aws::String &&  value)
inline

The SQL statement text to run.

Definition at line 222 of file RedshiftDataParameters.h.

◆ WithSql() [3/3]

RedshiftDataParameters& Aws::EventBridge::Model::RedshiftDataParameters::WithSql ( const char *  value)
inline

The SQL statement text to run.

Definition at line 227 of file RedshiftDataParameters.h.

◆ WithStatementName() [1/3]

RedshiftDataParameters& Aws::EventBridge::Model::RedshiftDataParameters::WithStatementName ( const Aws::String value)
inline

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

Definition at line 264 of file RedshiftDataParameters.h.

◆ WithStatementName() [2/3]

RedshiftDataParameters& Aws::EventBridge::Model::RedshiftDataParameters::WithStatementName ( Aws::String &&  value)
inline

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

Definition at line 270 of file RedshiftDataParameters.h.

◆ WithStatementName() [3/3]

RedshiftDataParameters& Aws::EventBridge::Model::RedshiftDataParameters::WithStatementName ( const char *  value)
inline

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

Definition at line 276 of file RedshiftDataParameters.h.

◆ WithWithEvent()

RedshiftDataParameters& Aws::EventBridge::Model::RedshiftDataParameters::WithWithEvent ( bool  value)
inline

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

Definition at line 301 of file RedshiftDataParameters.h.


The documentation for this class was generated from the following file: