Interface CfnPipe.IPipeTargetRedshiftDataParametersProperty
These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.
Namespace: Amazon.CDK.AWS.Pipes
Assembly: Amazon.CDK.AWS.Pipes.dll
Syntax (csharp)
public interface IPipeTargetRedshiftDataParametersProperty
Syntax (vb)
Public Interface IPipeTargetRedshiftDataParametersProperty
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.Pipes;
var pipeTargetRedshiftDataParametersProperty = new PipeTargetRedshiftDataParametersProperty {
Database = "database",
Sqls = new [] { "sqls" },
// the properties below are optional
DbUser = "dbUser",
SecretManagerArn = "secretManagerArn",
StatementName = "statementName",
WithEvent = false
};
Synopsis
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. |
Sqls | The SQL statement text to run. |
StatementName | The name of the SQL statement. |
WithEvent | Indicates whether to send an event back to EventBridge after the SQL statement runs. |
Properties
Database
The name of the database.
string Database { get; }
Property Value
System.String
Remarks
Required when authenticating using temporary credentials.
DbUser
The database user name.
virtual string DbUser { get; }
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.
virtual string SecretManagerArn { get; }
Property Value
System.String
Remarks
Required when authenticating using Secrets Manager .
Sqls
The SQL statement text to run.
string[] Sqls { get; }
Property Value
System.String[]
Remarks
StatementName
The name of the SQL statement.
virtual string StatementName { get; }
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.
virtual object WithEvent { get; }
Property Value
System.Object