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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String) 


616
617
618
619
620
621
622
623
624
625
626
627
628
629
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 616

class ExecuteStatementInput < Struct.new(
  :client_token,
  :cluster_identifier,
  :database,
  :db_user,
  :parameters,
  :secret_arn,
  :sql,
  :statement_name,
  :with_event,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_identifier ⇒ String

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

Returns:

  • (String) 


616
617
618
619
620
621
622
623
624
625
626
627
628
629
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 616

class ExecuteStatementInput < Struct.new(
  :client_token,
  :cluster_identifier,
  :database,
  :db_user,
  :parameters,
  :secret_arn,
  :sql,
  :statement_name,
  :with_event,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#database ⇒ String

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

Returns:

  • (String) 


616
617
618
619
620
621
622
623
624
625
626
627
628
629
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 616

class ExecuteStatementInput < Struct.new(
  :client_token,
  :cluster_identifier,
  :database,
  :db_user,
  :parameters,
  :secret_arn,
  :sql,
  :statement_name,
  :with_event,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#db_user ⇒ String

The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.

Returns:

  • (String) 


616
617
618
619
620
621
622
623
624
625
626
627
628
629
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 616

class ExecuteStatementInput < Struct.new(
  :client_token,
  :cluster_identifier,
  :database,
  :db_user,
  :parameters,
  :secret_arn,
  :sql,
  :statement_name,
  :with_event,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#parameters ⇒ Array<Types::SqlParameter>

The parameters for the SQL statement.

Returns:



616
617
618
619
620
621
622
623
624
625
626
627
628
629
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 616

class ExecuteStatementInput < Struct.new(
  :client_token,
  :cluster_identifier,
  :database,
  :db_user,
  :parameters,
  :secret_arn,
  :sql,
  :statement_name,
  :with_event,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#secret_arn ⇒ String

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

Returns:

  • (String) 


616
617
618
619
620
621
622
623
624
625
626
627
628
629
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 616

class ExecuteStatementInput < Struct.new(
  :client_token,
  :cluster_identifier,
  :database,
  :db_user,
  :parameters,
  :secret_arn,
  :sql,
  :statement_name,
  :with_event,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#sql ⇒ String

The SQL statement text to run.

Returns:

  • (String) 


616
617
618
619
620
621
622
623
624
625
626
627
628
629
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 616

class ExecuteStatementInput < Struct.new(
  :client_token,
  :cluster_identifier,
  :database,
  :db_user,
  :parameters,
  :secret_arn,
  :sql,
  :statement_name,
  :with_event,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

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


616
617
618
619
620
621
622
623
624
625
626
627
628
629
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 616

class ExecuteStatementInput < Struct.new(
  :client_token,
  :cluster_identifier,
  :database,
  :db_user,
  :parameters,
  :secret_arn,
  :sql,
  :statement_name,
  :with_event,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

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


616
617
618
619
620
621
622
623
624
625
626
627
628
629
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 616

class ExecuteStatementInput < Struct.new(
  :client_token,
  :cluster_identifier,
  :database,
  :db_user,
  :parameters,
  :secret_arn,
  :sql,
  :statement_name,
  :with_event,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end

#workgroup_name ⇒ String

The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

Returns:

  • (String) 


616
617
618
619
620
621
622
623
624
625
626
627
628
629
 
# File 'gems/aws-sdk-redshiftdataapiservice/lib/aws-sdk-redshiftdataapiservice/types.rb', line 616

class ExecuteStatementInput < Struct.new(
  :client_token,
  :cluster_identifier,
  :database,
  :db_user,
  :parameters,
  :secret_arn,
  :sql,
  :statement_name,
  :with_event,
  :workgroup_name)
  SENSITIVE = []
  include Aws::Structure
end