Class: Aws::RedshiftDataAPIService::Types::BatchExecuteStatementInput

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

Overview

Note:

When making an API call, you may pass BatchExecuteStatementInput data as a hash:

{
  cluster_identifier: "Location", # required
  database: "String", # required
  db_user: "String",
  secret_arn: "SecretArn",
  sqls: ["StatementString"], # required
  statement_name: "StatementNameString",
  with_event: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cluster_identifierString

The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

Returns:

  • (String)


96
97
98
99
100
101
102
103
104
105
106
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 96

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

#databaseString

The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

Returns:

  • (String)


96
97
98
99
100
101
102
103
104
105
106
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 96

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

#db_userString

The database user name. This parameter is required when authenticating using temporary credentials.

Returns:

  • (String)


96
97
98
99
100
101
102
103
104
105
106
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 96

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

#secret_arnString

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

Returns:

  • (String)


96
97
98
99
100
101
102
103
104
105
106
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 96

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

#sqlsArray<String>

One or more SQL statements to run.

Returns:

  • (Array<String>)


96
97
98
99
100
101
102
103
104
105
106
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 96

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

#statement_nameString

The name of the SQL statements. You can name the SQL statements when you create them to identify the query.

Returns:

  • (String)


96
97
98
99
100
101
102
103
104
105
106
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 96

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

#with_eventBoolean

A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statements run.

Returns:

  • (Boolean)


96
97
98
99
100
101
102
103
104
105
106
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 96

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