Class: Aws::RDSDataService::Types::ExecuteSqlRequest

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

Overview

Note:

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

{
  aws_secret_store_arn: "Arn", # required
  database: "DbName",
  db_cluster_or_instance_arn: "Arn", # required
  schema: "DbName",
  sql_statements: "SqlStatement", # required
}

The request parameters represent the input of a request to run one or more SQL statements.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aws_secret_store_arnString

The Amazon Resource Name (ARN) of the secret that enables access to the DB cluster.

Returns:

  • (String)


423
424
425
426
427
428
429
430
431
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 423

class ExecuteSqlRequest < Struct.new(
  :aws_secret_store_arn,
  :database,
  :db_cluster_or_instance_arn,
  :schema,
  :sql_statements)
  SENSITIVE = []
  include Aws::Structure
end

#databaseString

The name of the database.

Returns:

  • (String)


423
424
425
426
427
428
429
430
431
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 423

class ExecuteSqlRequest < Struct.new(
  :aws_secret_store_arn,
  :database,
  :db_cluster_or_instance_arn,
  :schema,
  :sql_statements)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_or_instance_arnString

The ARN of the Aurora Serverless DB cluster.

Returns:

  • (String)


423
424
425
426
427
428
429
430
431
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 423

class ExecuteSqlRequest < Struct.new(
  :aws_secret_store_arn,
  :database,
  :db_cluster_or_instance_arn,
  :schema,
  :sql_statements)
  SENSITIVE = []
  include Aws::Structure
end

#schemaString

The name of the database schema.

Returns:

  • (String)


423
424
425
426
427
428
429
430
431
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 423

class ExecuteSqlRequest < Struct.new(
  :aws_secret_store_arn,
  :database,
  :db_cluster_or_instance_arn,
  :schema,
  :sql_statements)
  SENSITIVE = []
  include Aws::Structure
end

#sql_statementsString

One or more SQL statements to run on the DB cluster.

You can separate SQL statements from each other with a semicolon (;). Any valid SQL statement is permitted, including data definition, data manipulation, and commit statements.

Returns:

  • (String)


423
424
425
426
427
428
429
430
431
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 423

class ExecuteSqlRequest < Struct.new(
  :aws_secret_store_arn,
  :database,
  :db_cluster_or_instance_arn,
  :schema,
  :sql_statements)
  SENSITIVE = []
  include Aws::Structure
end