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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb

Overview

Note:

When making an API call, you may pass RedshiftDataParameters data as a 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 Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#databaseString

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

Returns:

  • (String)


4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4765

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

#db_userString

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

Returns:

  • (String)


4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4765

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

#secret_manager_arnString

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

Returns:

  • (String)


4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4765

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

#sqlString

The SQL statement text to run.

Returns:

  • (String)


4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4765

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

#statement_nameString

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

Returns:

  • (String)


4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4765

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

#with_eventBoolean

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

Returns:

  • (Boolean)


4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4765

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