Class: Aws::Pipes::Types::PipeTargetRedshiftDataParameters

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

See Also:

Constant Summary collapse

SENSITIVE = 
[:database, :db_user, :statement_name]

Instance Attribute Summary collapse

Instance Attribute Details

#database ⇒ String

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

Returns:

  • (String) 


2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
 
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 2423

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

#db_user ⇒ String

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

Returns:

  • (String) 


2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
 
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 2423

class PipeTargetRedshiftDataParameters < Struct.new(
  :database,
  :db_user,
  :secret_manager_arn,
  :sqls,
  :statement_name,
  :with_event)
  SENSITIVE = [:database, :db_user, :statement_name]
  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 Secrets Manager.

Returns:

  • (String) 


2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
 
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 2423

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

#sqls ⇒ Array<String>

The SQL statement text to run.

Returns:

  • (Array<String>) 


2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
 
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 2423

class PipeTargetRedshiftDataParameters < Struct.new(
  :database,
  :db_user,
  :secret_manager_arn,
  :sqls,
  :statement_name,
  :with_event)
  SENSITIVE = [:database, :db_user, :statement_name]
  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) 


2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
 
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 2423

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

#with_event ⇒ Boolean

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

Returns:

  • (Boolean) 


2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
 
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 2423

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