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

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

Overview

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aws_secret_store_arn ⇒ String

The Amazon Resource Name (ARN) of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in the secret.

For information about creating the secret, see [Create a database secret].

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html

Returns:

  • (String) 


429
430
431
432
433
434
435
436
437
 
# File 'lib/aws-sdk-rdsdataservice/types.rb', line 429

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

#database ⇒ String

The name of the database.

Returns:

  • (String) 


429
430
431
432
433
434
435
436
437
 
# File 'lib/aws-sdk-rdsdataservice/types.rb', line 429

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

#db_cluster_or_instance_arn ⇒ String

The ARN of the Aurora Serverless DB cluster.

Returns:

  • (String) 


429
430
431
432
433
434
435
436
437
 
# File 'lib/aws-sdk-rdsdataservice/types.rb', line 429

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

#schema ⇒ String

The name of the database schema.

Returns:

  • (String) 


429
430
431
432
433
434
435
436
437
 
# File 'lib/aws-sdk-rdsdataservice/types.rb', line 429

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

#sql_statements ⇒ String

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) 


429
430
431
432
433
434
435
436
437
 
# File 'lib/aws-sdk-rdsdataservice/types.rb', line 429

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