aws-cdk-lib/aws-events-targets/lib/redshift-query.d.ts

Version 2 of the AWS Cloud Development Kit library

import * as events from '../../aws-events';
import * as iam from '../../aws-iam';
import * as secretsmanager from '../../aws-secretsmanager';
import * as sqs from '../../aws-sqs';
/**
 * Configuration properties of an Amazon Redshift Query event.
 */
export interface RedshiftQueryProps {
    /**
     * The Amazon Redshift database to run the query against.
     */
    readonly database: string;
    /**
     * The Amazon Redshift database user to run the query as. This is required when authenticating via temporary credentials.
     *
     * @default - No Database user is specified
     */
    readonly dbUser?: string;
    /**
     * The secret containing the password for the database user. This is required when authenticating via Secrets Manager.
     * If the full secret ARN is not specified, this will instead use the secret name.
     *
     * @default - No secret is specified
     */
    readonly secret?: secretsmanager.ISecret;
    /**
     * The SQL queries to be executed. Each query is run sequentially within a single transaction; the next query in the array will only execute after the previous one has successfully completed.
     *
     * - When multiple sql queries are included, this will use the `batchExecuteStatement` API. Therefore, if any statement fails, the entire transaction is rolled back.
     * - If a single SQL statement is to be executed, this will use the `executeStatement` API.
     *
     * @default - No SQL query is specified
     */
    readonly sql: string[];
    /**
     * The name of the SQL statement. You can name the SQL statement for identitfication purposes. If you would like Amazon Redshift to identify the Event Bridge rule, and present it in the Amazon Redshift console, append a `QS2-` prefix to the statement name.
     *
     * @default - No statement name is specified
     */
    readonly statementName?: string;
    /**
     * Should an event be sent back to Event Bridge when the SQL statement is executed.
     *
     * @default false
     */
    readonly sendEventBridgeEvent?: boolean;
    /**
     * The queue to be used as dead letter queue.
     *
     * @default - No dead letter queue is specified
     */
    readonly deadLetterQueue?: sqs.IQueue;
    /**
     * The IAM role to be used to execute the SQL statement.
     *
     * @default - a new role will be created.
     */
    readonly role?: iam.IRole;
    /**
     * The input to the state machine execution
     *
     * @default - the entire EventBridge event
     */
    readonly input?: events.RuleTargetInput;
}
/**
 * Schedule an Amazon Redshift Query to be run, using the Redshift Data API.
 *
 * If you would like Amazon Redshift to identify the Event Bridge rule, and present it in the Amazon Redshift console, append a `QS2-` prefix to both `statementName` and `ruleName`.
 */
export declare class RedshiftQuery implements events.IRuleTarget {
    /**
     * The ARN of the Amazon Redshift cluster
     */
    private readonly clusterArn;
    /**
     * The properties of the Redshift Query event
     */
    private readonly props;
    constructor(
    /**
     * The ARN of the Amazon Redshift cluster
     */
    clusterArn: string, 
    /**
     * The properties of the Redshift Query event
     */
    props: RedshiftQueryProps);
    bind(rule: events.IRule, _id?: string): events.RuleTargetConfig;
    private putEventStatement;
    private putBatchEventStatement;
}