You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::EventBridge::Types::RedshiftDataParameters

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing RedshiftDataParameters as input to an Aws::Client method, you can use a vanilla Hash:

{
  secret_manager_arn: "RedshiftSecretManagerArn",
  database: "Database", # required
  db_user: "DbUser",
  sql: "Sql", # required
  statement_name: "StatementName",
  with_event: false,
}

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.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#database ⇒ String

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

Returns:

  • (String) —

    The name of the database.

#db_user ⇒ String

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

Returns:

  • (String) —

    The database user name.

#secret_manager_arn ⇒ String

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

Returns:

  • (String) —

    The name or ARN of the secret that enables access to the database.

#sql ⇒ String

The SQL statement text to run.

Returns:

  • (String) —

    The SQL statement text to run.

#statement_name ⇒ String

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

Returns:

  • (String) —

    The name of the SQL statement.

#with_event ⇒ Boolean

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

Returns:

  • (Boolean) —

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