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

Inherits:

Struct

• Object
• Struct
• Aws::EventBridge::Types::RedshiftDataParameters

Includes:

Structure

Defined in:

lib/aws-sdk-eventbridge/types.rb

Overview

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:sql, :sqls]

Instance Attribute Summary

• #database ⇒ String

  The name of the database.

• #db_user ⇒ String

  The database user name.

• #secret_manager_arn ⇒ String

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

• #sql ⇒ String

  The SQL statement text to run.

• #sqls ⇒ Array<String>

  One or more SQL statements to run.

• #statement_name ⇒ String

  The name of the SQL statement.

• #with_event ⇒ Boolean

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

Instance Attribute Details

#database ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-eventbridge/types.rb', line 4375

class RedshiftDataParameters < Struct.new(
  :secret_manager_arn,
  :database,
  :db_user,
  :sql,
  :statement_name,
  :with_event,
  :sqls)
  SENSITIVE = [:sql, :sqls]
  include Aws::Structure
end

#db_user ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-eventbridge/types.rb', line 4375

class RedshiftDataParameters < Struct.new(
  :secret_manager_arn,
  :database,
  :db_user,
  :sql,
  :statement_name,
  :with_event,
  :sqls)
  SENSITIVE = [:sql, :sqls]
  include Aws::Structure
end

#secret_manager_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-eventbridge/types.rb', line 4375

class RedshiftDataParameters < Struct.new(
  :secret_manager_arn,
  :database,
  :db_user,
  :sql,
  :statement_name,
  :with_event,
  :sqls)
  SENSITIVE = [:sql, :sqls]
  include Aws::Structure
end

#sql ⇒ String

The SQL statement text to run.

Returns:

• (String)

# File 'lib/aws-sdk-eventbridge/types.rb', line 4375

class RedshiftDataParameters < Struct.new(
  :secret_manager_arn,
  :database,
  :db_user,
  :sql,
  :statement_name,
  :with_event,
  :sqls)
  SENSITIVE = [:sql, :sqls]
  include Aws::Structure
end

#sqls ⇒ Array<String>

One or more SQL statements to run. 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.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-eventbridge/types.rb', line 4375

class RedshiftDataParameters < Struct.new(
  :secret_manager_arn,
  :database,
  :db_user,
  :sql,
  :statement_name,
  :with_event,
  :sqls)
  SENSITIVE = [:sql, :sqls]
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-eventbridge/types.rb', line 4375

class RedshiftDataParameters < Struct.new(
  :secret_manager_arn,
  :database,
  :db_user,
  :sql,
  :statement_name,
  :with_event,
  :sqls)
  SENSITIVE = [:sql, :sqls]
  include Aws::Structure
end

#with_event ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-eventbridge/types.rb', line 4375

class RedshiftDataParameters < Struct.new(
  :secret_manager_arn,
  :database,
  :db_user,
  :sql,
  :statement_name,
  :with_event,
  :sqls)
  SENSITIVE = [:sql, :sqls]
  include Aws::Structure
end