Class CfnRule.RedshiftDataParametersProperty
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.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Events
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class RedshiftDataParametersProperty : Object, CfnRule.IRedshiftDataParametersProperty
Syntax (vb)
Public Class RedshiftDataParametersProperty
Inherits Object
Implements CfnRule.IRedshiftDataParametersProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Events;
var redshiftDataParametersProperty = new RedshiftDataParametersProperty {
Database = "database",
// the properties below are optional
DbUser = "dbUser",
SecretManagerArn = "secretManagerArn",
Sql = "sql",
Sqls = new [] { "sqls" },
StatementName = "statementName",
WithEvent = false
};
Synopsis
Constructors
RedshiftDataParametersProperty() |
Properties
Database | The name of the database. |
DbUser | The database user name. |
SecretManagerArn | The name or ARN of the secret that enables access to the database. |
Sql | The SQL statement text to run. |
Sqls | One or more SQL statements to run. |
StatementName | The name of the SQL statement. |
WithEvent | Indicates whether to send an event back to EventBridge after the SQL statement runs. |
Constructors
RedshiftDataParametersProperty()
public RedshiftDataParametersProperty()
Properties
Database
The name of the database.
public string Database { get; set; }
Property Value
System.String
Remarks
Required when authenticating using temporary credentials.
DbUser
The database user name.
public string DbUser { get; set; }
Property Value
System.String
Remarks
Required when authenticating using temporary credentials.
SecretManagerArn
The name or ARN of the secret that enables access to the database.
public string SecretManagerArn { get; set; }
Property Value
System.String
Remarks
Required when authenticating using AWS Secrets Manager.
Sql
The SQL statement text to run.
public string Sql { get; set; }
Property Value
System.String
Remarks
Sqls
One or more SQL statements to run.
public string[] Sqls { get; set; }
Property Value
System.String[]
Remarks
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.
StatementName
The name of the SQL statement.
public string StatementName { get; set; }
Property Value
System.String
Remarks
You can name the SQL statement when you create it to identify the query.
WithEvent
Indicates whether to send an event back to EventBridge after the SQL statement runs.
public object WithEvent { get; set; }
Property Value
System.Object