/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include namespace Aws { namespace RDSDataService { namespace Model { /** *

The request parameters represent the input of a request to run a SQL * statement against a database.

See Also:

AWS * API Reference

*/ class ExecuteStatementRequest : public RDSDataServiceRequest { public: AWS_RDSDATASERVICE_API ExecuteStatementRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "ExecuteStatement"; } AWS_RDSDATASERVICE_API Aws::String SerializePayload() const override; /** *

The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

*/ inline const Aws::String& GetResourceArn() const{ return m_resourceArn; } /** *

The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

*/ inline bool ResourceArnHasBeenSet() const { return m_resourceArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

*/ inline void SetResourceArn(const Aws::String& value) { m_resourceArnHasBeenSet = true; m_resourceArn = value; } /** *

The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

*/ inline void SetResourceArn(Aws::String&& value) { m_resourceArnHasBeenSet = true; m_resourceArn = std::move(value); } /** *

The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

*/ inline void SetResourceArn(const char* value) { m_resourceArnHasBeenSet = true; m_resourceArn.assign(value); } /** *

The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

*/ inline ExecuteStatementRequest& WithResourceArn(const Aws::String& value) { SetResourceArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

*/ inline ExecuteStatementRequest& WithResourceArn(Aws::String&& value) { SetResourceArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

*/ inline ExecuteStatementRequest& WithResourceArn(const char* value) { SetResourceArn(value); return *this;} /** *

The 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.

*/ inline const Aws::String& GetSecretArn() const{ return m_secretArn; } /** *

The 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.

*/ inline bool SecretArnHasBeenSet() const { return m_secretArnHasBeenSet; } /** *

The 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.

*/ inline void SetSecretArn(const Aws::String& value) { m_secretArnHasBeenSet = true; m_secretArn = value; } /** *

The 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.

*/ inline void SetSecretArn(Aws::String&& value) { m_secretArnHasBeenSet = true; m_secretArn = std::move(value); } /** *

The 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.

*/ inline void SetSecretArn(const char* value) { m_secretArnHasBeenSet = true; m_secretArn.assign(value); } /** *

The 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.

*/ inline ExecuteStatementRequest& WithSecretArn(const Aws::String& value) { SetSecretArn(value); return *this;} /** *

The 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.

*/ inline ExecuteStatementRequest& WithSecretArn(Aws::String&& value) { SetSecretArn(std::move(value)); return *this;} /** *

The 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.

*/ inline ExecuteStatementRequest& WithSecretArn(const char* value) { SetSecretArn(value); return *this;} /** *

The SQL statement to run.

*/ inline const Aws::String& GetSql() const{ return m_sql; } /** *

The SQL statement to run.

*/ inline bool SqlHasBeenSet() const { return m_sqlHasBeenSet; } /** *

The SQL statement to run.

*/ inline void SetSql(const Aws::String& value) { m_sqlHasBeenSet = true; m_sql = value; } /** *

The SQL statement to run.

*/ inline void SetSql(Aws::String&& value) { m_sqlHasBeenSet = true; m_sql = std::move(value); } /** *

The SQL statement to run.

*/ inline void SetSql(const char* value) { m_sqlHasBeenSet = true; m_sql.assign(value); } /** *

The SQL statement to run.

*/ inline ExecuteStatementRequest& WithSql(const Aws::String& value) { SetSql(value); return *this;} /** *

The SQL statement to run.

*/ inline ExecuteStatementRequest& WithSql(Aws::String&& value) { SetSql(std::move(value)); return *this;} /** *

The SQL statement to run.

*/ inline ExecuteStatementRequest& WithSql(const char* value) { SetSql(value); return *this;} /** *

The name of the database.

*/ inline const Aws::String& GetDatabase() const{ return m_database; } /** *

The name of the database.

*/ inline bool DatabaseHasBeenSet() const { return m_databaseHasBeenSet; } /** *

The name of the database.

*/ inline void SetDatabase(const Aws::String& value) { m_databaseHasBeenSet = true; m_database = value; } /** *

The name of the database.

*/ inline void SetDatabase(Aws::String&& value) { m_databaseHasBeenSet = true; m_database = std::move(value); } /** *

The name of the database.

*/ inline void SetDatabase(const char* value) { m_databaseHasBeenSet = true; m_database.assign(value); } /** *

The name of the database.

*/ inline ExecuteStatementRequest& WithDatabase(const Aws::String& value) { SetDatabase(value); return *this;} /** *

The name of the database.

*/ inline ExecuteStatementRequest& WithDatabase(Aws::String&& value) { SetDatabase(std::move(value)); return *this;} /** *

The name of the database.

*/ inline ExecuteStatementRequest& WithDatabase(const char* value) { SetDatabase(value); return *this;} /** *

The name of the database schema.

Currently, the * schema parameter isn't supported.

*/ inline const Aws::String& GetSchema() const{ return m_schema; } /** *

The name of the database schema.

Currently, the * schema parameter isn't supported.

*/ inline bool SchemaHasBeenSet() const { return m_schemaHasBeenSet; } /** *

The name of the database schema.

Currently, the * schema parameter isn't supported.

*/ inline void SetSchema(const Aws::String& value) { m_schemaHasBeenSet = true; m_schema = value; } /** *

The name of the database schema.

Currently, the * schema parameter isn't supported.

*/ inline void SetSchema(Aws::String&& value) { m_schemaHasBeenSet = true; m_schema = std::move(value); } /** *

The name of the database schema.

Currently, the * schema parameter isn't supported.

*/ inline void SetSchema(const char* value) { m_schemaHasBeenSet = true; m_schema.assign(value); } /** *

The name of the database schema.

Currently, the * schema parameter isn't supported.

*/ inline ExecuteStatementRequest& WithSchema(const Aws::String& value) { SetSchema(value); return *this;} /** *

The name of the database schema.

Currently, the * schema parameter isn't supported.

*/ inline ExecuteStatementRequest& WithSchema(Aws::String&& value) { SetSchema(std::move(value)); return *this;} /** *

The name of the database schema.

Currently, the * schema parameter isn't supported.

*/ inline ExecuteStatementRequest& WithSchema(const char* value) { SetSchema(value); return *this;} /** *

The parameters for the SQL statement.

Array parameters are not * supported.

*/ inline const Aws::Vector& GetParameters() const{ return m_parameters; } /** *

The parameters for the SQL statement.

Array parameters are not * supported.

*/ inline bool ParametersHasBeenSet() const { return m_parametersHasBeenSet; } /** *

The parameters for the SQL statement.

Array parameters are not * supported.

*/ inline void SetParameters(const Aws::Vector& value) { m_parametersHasBeenSet = true; m_parameters = value; } /** *

The parameters for the SQL statement.

Array parameters are not * supported.

*/ inline void SetParameters(Aws::Vector&& value) { m_parametersHasBeenSet = true; m_parameters = std::move(value); } /** *

The parameters for the SQL statement.

Array parameters are not * supported.

*/ inline ExecuteStatementRequest& WithParameters(const Aws::Vector& value) { SetParameters(value); return *this;} /** *

The parameters for the SQL statement.

Array parameters are not * supported.

*/ inline ExecuteStatementRequest& WithParameters(Aws::Vector&& value) { SetParameters(std::move(value)); return *this;} /** *

The parameters for the SQL statement.

Array parameters are not * supported.

*/ inline ExecuteStatementRequest& AddParameters(const SqlParameter& value) { m_parametersHasBeenSet = true; m_parameters.push_back(value); return *this; } /** *

The parameters for the SQL statement.

Array parameters are not * supported.

*/ inline ExecuteStatementRequest& AddParameters(SqlParameter&& value) { m_parametersHasBeenSet = true; m_parameters.push_back(std::move(value)); return *this; } /** *

The identifier of a transaction that was started by using the * BeginTransaction operation. Specify the transaction ID of the * transaction that you want to include the SQL statement in.

If the SQL * statement is not part of a transaction, don't set this parameter.

*/ inline const Aws::String& GetTransactionId() const{ return m_transactionId; } /** *

The identifier of a transaction that was started by using the * BeginTransaction operation. Specify the transaction ID of the * transaction that you want to include the SQL statement in.

If the SQL * statement is not part of a transaction, don't set this parameter.

*/ inline bool TransactionIdHasBeenSet() const { return m_transactionIdHasBeenSet; } /** *

The identifier of a transaction that was started by using the * BeginTransaction operation. Specify the transaction ID of the * transaction that you want to include the SQL statement in.

If the SQL * statement is not part of a transaction, don't set this parameter.

*/ inline void SetTransactionId(const Aws::String& value) { m_transactionIdHasBeenSet = true; m_transactionId = value; } /** *

The identifier of a transaction that was started by using the * BeginTransaction operation. Specify the transaction ID of the * transaction that you want to include the SQL statement in.

If the SQL * statement is not part of a transaction, don't set this parameter.

*/ inline void SetTransactionId(Aws::String&& value) { m_transactionIdHasBeenSet = true; m_transactionId = std::move(value); } /** *

The identifier of a transaction that was started by using the * BeginTransaction operation. Specify the transaction ID of the * transaction that you want to include the SQL statement in.

If the SQL * statement is not part of a transaction, don't set this parameter.

*/ inline void SetTransactionId(const char* value) { m_transactionIdHasBeenSet = true; m_transactionId.assign(value); } /** *

The identifier of a transaction that was started by using the * BeginTransaction operation. Specify the transaction ID of the * transaction that you want to include the SQL statement in.

If the SQL * statement is not part of a transaction, don't set this parameter.

*/ inline ExecuteStatementRequest& WithTransactionId(const Aws::String& value) { SetTransactionId(value); return *this;} /** *

The identifier of a transaction that was started by using the * BeginTransaction operation. Specify the transaction ID of the * transaction that you want to include the SQL statement in.

If the SQL * statement is not part of a transaction, don't set this parameter.

*/ inline ExecuteStatementRequest& WithTransactionId(Aws::String&& value) { SetTransactionId(std::move(value)); return *this;} /** *

The identifier of a transaction that was started by using the * BeginTransaction operation. Specify the transaction ID of the * transaction that you want to include the SQL statement in.

If the SQL * statement is not part of a transaction, don't set this parameter.

*/ inline ExecuteStatementRequest& WithTransactionId(const char* value) { SetTransactionId(value); return *this;} /** *

A value that indicates whether to include metadata in the results.

*/ inline bool GetIncludeResultMetadata() const{ return m_includeResultMetadata; } /** *

A value that indicates whether to include metadata in the results.

*/ inline bool IncludeResultMetadataHasBeenSet() const { return m_includeResultMetadataHasBeenSet; } /** *

A value that indicates whether to include metadata in the results.

*/ inline void SetIncludeResultMetadata(bool value) { m_includeResultMetadataHasBeenSet = true; m_includeResultMetadata = value; } /** *

A value that indicates whether to include metadata in the results.

*/ inline ExecuteStatementRequest& WithIncludeResultMetadata(bool value) { SetIncludeResultMetadata(value); return *this;} /** *

A value that indicates whether to continue running the statement after the * call times out. By default, the statement stops running when the call times * out.

For DDL statements, we recommend continuing to run the * statement after the call times out. When a DDL statement terminates before it is * finished running, it can result in errors and possibly corrupted data * structures.

*/ inline bool GetContinueAfterTimeout() const{ return m_continueAfterTimeout; } /** *

A value that indicates whether to continue running the statement after the * call times out. By default, the statement stops running when the call times * out.

For DDL statements, we recommend continuing to run the * statement after the call times out. When a DDL statement terminates before it is * finished running, it can result in errors and possibly corrupted data * structures.

*/ inline bool ContinueAfterTimeoutHasBeenSet() const { return m_continueAfterTimeoutHasBeenSet; } /** *

A value that indicates whether to continue running the statement after the * call times out. By default, the statement stops running when the call times * out.

For DDL statements, we recommend continuing to run the * statement after the call times out. When a DDL statement terminates before it is * finished running, it can result in errors and possibly corrupted data * structures.

*/ inline void SetContinueAfterTimeout(bool value) { m_continueAfterTimeoutHasBeenSet = true; m_continueAfterTimeout = value; } /** *

A value that indicates whether to continue running the statement after the * call times out. By default, the statement stops running when the call times * out.

For DDL statements, we recommend continuing to run the * statement after the call times out. When a DDL statement terminates before it is * finished running, it can result in errors and possibly corrupted data * structures.

*/ inline ExecuteStatementRequest& WithContinueAfterTimeout(bool value) { SetContinueAfterTimeout(value); return *this;} /** *

Options that control how the result set is returned.

*/ inline const ResultSetOptions& GetResultSetOptions() const{ return m_resultSetOptions; } /** *

Options that control how the result set is returned.

*/ inline bool ResultSetOptionsHasBeenSet() const { return m_resultSetOptionsHasBeenSet; } /** *

Options that control how the result set is returned.

*/ inline void SetResultSetOptions(const ResultSetOptions& value) { m_resultSetOptionsHasBeenSet = true; m_resultSetOptions = value; } /** *

Options that control how the result set is returned.

*/ inline void SetResultSetOptions(ResultSetOptions&& value) { m_resultSetOptionsHasBeenSet = true; m_resultSetOptions = std::move(value); } /** *

Options that control how the result set is returned.

*/ inline ExecuteStatementRequest& WithResultSetOptions(const ResultSetOptions& value) { SetResultSetOptions(value); return *this;} /** *

Options that control how the result set is returned.

*/ inline ExecuteStatementRequest& WithResultSetOptions(ResultSetOptions&& value) { SetResultSetOptions(std::move(value)); return *this;} /** *

A value that indicates whether to format the result set as a single JSON * string. This parameter only applies to SELECT statements and is * ignored for other types of statements. Allowed values are NONE and * JSON. The default value is NONE. The result is * returned in the formattedRecords field.

For usage * information about the JSON format for result sets, see Using * the Data API in the Amazon Aurora User Guide.

*/ inline const RecordsFormatType& GetFormatRecordsAs() const{ return m_formatRecordsAs; } /** *

A value that indicates whether to format the result set as a single JSON * string. This parameter only applies to SELECT statements and is * ignored for other types of statements. Allowed values are NONE and * JSON. The default value is NONE. The result is * returned in the formattedRecords field.

For usage * information about the JSON format for result sets, see Using * the Data API in the Amazon Aurora User Guide.

*/ inline bool FormatRecordsAsHasBeenSet() const { return m_formatRecordsAsHasBeenSet; } /** *

A value that indicates whether to format the result set as a single JSON * string. This parameter only applies to SELECT statements and is * ignored for other types of statements. Allowed values are NONE and * JSON. The default value is NONE. The result is * returned in the formattedRecords field.

For usage * information about the JSON format for result sets, see Using * the Data API in the Amazon Aurora User Guide.

*/ inline void SetFormatRecordsAs(const RecordsFormatType& value) { m_formatRecordsAsHasBeenSet = true; m_formatRecordsAs = value; } /** *

A value that indicates whether to format the result set as a single JSON * string. This parameter only applies to SELECT statements and is * ignored for other types of statements. Allowed values are NONE and * JSON. The default value is NONE. The result is * returned in the formattedRecords field.

For usage * information about the JSON format for result sets, see Using * the Data API in the Amazon Aurora User Guide.

*/ inline void SetFormatRecordsAs(RecordsFormatType&& value) { m_formatRecordsAsHasBeenSet = true; m_formatRecordsAs = std::move(value); } /** *

A value that indicates whether to format the result set as a single JSON * string. This parameter only applies to SELECT statements and is * ignored for other types of statements. Allowed values are NONE and * JSON. The default value is NONE. The result is * returned in the formattedRecords field.

For usage * information about the JSON format for result sets, see Using * the Data API in the Amazon Aurora User Guide.

*/ inline ExecuteStatementRequest& WithFormatRecordsAs(const RecordsFormatType& value) { SetFormatRecordsAs(value); return *this;} /** *

A value that indicates whether to format the result set as a single JSON * string. This parameter only applies to SELECT statements and is * ignored for other types of statements. Allowed values are NONE and * JSON. The default value is NONE. The result is * returned in the formattedRecords field.

For usage * information about the JSON format for result sets, see Using * the Data API in the Amazon Aurora User Guide.

*/ inline ExecuteStatementRequest& WithFormatRecordsAs(RecordsFormatType&& value) { SetFormatRecordsAs(std::move(value)); return *this;} private: Aws::String m_resourceArn; bool m_resourceArnHasBeenSet = false; Aws::String m_secretArn; bool m_secretArnHasBeenSet = false; Aws::String m_sql; bool m_sqlHasBeenSet = false; Aws::String m_database; bool m_databaseHasBeenSet = false; Aws::String m_schema; bool m_schemaHasBeenSet = false; Aws::Vector m_parameters; bool m_parametersHasBeenSet = false; Aws::String m_transactionId; bool m_transactionIdHasBeenSet = false; bool m_includeResultMetadata; bool m_includeResultMetadataHasBeenSet = false; bool m_continueAfterTimeout; bool m_continueAfterTimeoutHasBeenSet = false; ResultSetOptions m_resultSetOptions; bool m_resultSetOptionsHasBeenSet = false; RecordsFormatType m_formatRecordsAs; bool m_formatRecordsAsHasBeenSet = false; }; } // namespace Model } // namespace RDSDataService } // namespace Aws