PipeTargetRedshiftDataParametersProperty Struct
These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_pipes as pipes } from 'aws-cdk-lib';
const pipeTargetRedshiftDataParametersProperty: pipes.CfnPipe.PipeTargetRedshiftDataParametersProperty = {
database: 'database',
sqls: ['sqls'],
// the properties below are optional
dbUser: 'dbUser',
secretManagerArn: 'secretManagerArn',
statementName: 'statementName',
withEvent: false,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_pipes as pipes
pipe_target_redshift_data_parameters_property = pipes.CfnPipe.PipeTargetRedshiftDataParametersProperty(
database="database",
sqls=["sqls"],
# the properties below are optional
db_user="dbUser",
secret_manager_arn="secretManagerArn",
statement_name="statementName",
with_event=False
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.pipes.*;
PipeTargetRedshiftDataParametersProperty pipeTargetRedshiftDataParametersProperty = PipeTargetRedshiftDataParametersProperty.builder()
.database("database")
.sqls(List.of("sqls"))
// the properties below are optional
.dbUser("dbUser")
.secretManagerArn("secretManagerArn")
.statementName("statementName")
.withEvent(false)
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
pipeTargetRedshiftDataParametersProperty := &PipeTargetRedshiftDataParametersProperty{
Database: jsii.String("database"),
Sqls: []*string{
jsii.String("sqls"),
},
// the properties below are optional
DbUser: jsii.String("dbUser"),
SecretManagerArn: jsii.String("secretManagerArn"),
StatementName: jsii.String("statementName"),
WithEvent: jsii.Boolean(false),
}
Properties
The name of the database.
Required when authenticating using temporary credentials.
dbUseroptionalstringdb_useroptionalstrdbUseroptionalStringDbUseroptionalstringDbUseroptional*string#The database user name.
Required when authenticating using temporary credentials.
secretManagerArnoptionalstringsecret_manager_arnoptionalstrsecretManagerArnoptionalStringSecretManagerArnoptionalstringSecretManagerArnoptional*string#The name or ARN of the secret that enables access to the database.
Required when authenticating using Secrets Manager.
The SQL statement text to run.
statementNameoptionalstringstatement_nameoptionalstrstatementNameoptionalStringStatementNameoptionalstringStatementNameoptional*string#The name of the SQL statement.
You can name the SQL statement when you create it to identify the query.
withEventoptionalboolean | IResolvablewith_eventoptionaltyping.Union[bool, IResolvable]withEventoptionalBooleanWithEventoptionalboolWithEventoptionalinterface{}= false#Indicates whether to send an event back to EventBridge after the SQL statement runs.