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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-eventbridge/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:

Constant Summary collapse

SENSITIVE = 
[:sql, :sqls]

Instance Attribute Summary collapse

Instance Attribute Details

#database ⇒ String

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

Returns:

  • (String) 


3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 3906

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) 


3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 3906

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) 


3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 3906

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) 


3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 3906

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


3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 3906

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) 


3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 3906

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) 


3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 3906

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