You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::RedshiftDataAPIService::Types::ExecuteStatementInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ExecuteStatementInput as input to an Aws::Client method, you can use a vanilla Hash:

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#cluster_identifier ⇒ String

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

Returns:

  • (String) —

    The cluster identifier.

#database ⇒ String

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

Returns:

  • (String) —

    The name of the database.

#db_user ⇒ String

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

Returns:

  • (String) —

    The database user name.

#secret_arn ⇒ String

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

Returns:

  • (String) —

    The name or ARN of the secret that enables access to the database.

#sql ⇒ String

The SQL statement text to run.

Returns:

  • (String) —

    The SQL statement text to run.

#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) —

    The name of the SQL statement.

#with_event ⇒ Boolean

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

Returns:

  • (Boolean) —

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