Skip to content

Commit 75dd16f

Browse files
psantuspsantus
committed
Add aws_rdsdata_query action
1 parent 00a40b6 commit 75dd16f

File tree

4 files changed

+374
-0
lines changed

4 files changed

+374
-0
lines changed

‎internal/service/rdsdata/query_action.go‎

Lines changed: 185 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,185 @@
1+
// Copyright (c) HashiCorp, Inc.
2+
// SPDX-License-Identifier: MPL-2.0
3+
4+
package rdsdata
5+
6+
import (
7+
"context"
8+
"fmt"
9+
10+
"github.com/aws/aws-sdk-go-v2/aws"
11+
"github.com/aws/aws-sdk-go-v2/service/rdsdata"
12+
"github.com/aws/aws-sdk-go-v2/service/rdsdata/types"
13+
"github.com/hashicorp/terraform-plugin-framework/action"
14+
"github.com/hashicorp/terraform-plugin-framework/action/schema"
15+
fwtypes2 "github.com/hashicorp/terraform-plugin-framework/types"
16+
"github.com/hashicorp/terraform-plugin-log/tflog"
17+
"github.com/hashicorp/terraform-provider-aws/internal/conns"
18+
"github.com/hashicorp/terraform-provider-aws/internal/framework"
19+
fwtypes "github.com/hashicorp/terraform-provider-aws/internal/framework/types"
20+
"github.com/hashicorp/terraform-provider-aws/names"
21+
)
22+
23+
// @Action(aws_rdsdata_query, name="RDS Data Query")
24+
func newQueryAction(_ context.Context) (action.ActionWithConfigure, error) {
25+
return &queryAction{}, nil
26+
}
27+
28+
// NewQueryAction creates a new query action for testing
29+
func NewQueryAction(ctx context.Context) (action.ActionWithConfigure, error) {
30+
return newQueryAction(ctx)
31+
}
32+
33+
var (
34+
_ action.Action = (*queryAction)(nil)
35+
)
36+
37+
type queryAction struct {
38+
framework.ActionWithModel[queryActionModel]
39+
client *rdsdata.Client
40+
}
41+
42+
type queryActionModel struct {
43+
framework.WithRegionModel
44+
ResourceArn fwtypes2.String `tfsdk:"resource_arn"`
45+
SecretArn fwtypes2.String `tfsdk:"secret_arn"`
46+
SQL fwtypes2.String `tfsdk:"sql"`
47+
Database fwtypes2.String `tfsdk:"database"`
48+
Parameters fwtypes.ListNestedObjectValueOf[sqlParameterModel] `tfsdk:"parameters"`
49+
IncludeResultMetadata fwtypes2.Bool `tfsdk:"include_result_metadata"`
50+
}
51+
52+
type sqlParameterModel struct {
53+
Name fwtypes2.String `tfsdk:"name"`
54+
Value fwtypes2.String `tfsdk:"value"`
55+
}
56+
57+
func (a *queryAction) Metadata(ctx context.Context, req action.MetadataRequest, resp *action.MetadataResponse) {
58+
resp.TypeName = req.ProviderTypeName + "_rdsdata_query"
59+
}
60+
61+
func (a *queryAction) Schema(ctx context.Context, req action.SchemaRequest, resp *action.SchemaResponse) {
62+
resp.Schema = schema.Schema{
63+
Description: "Executes SQL queries against Aurora Serverless clusters using RDS Data API",
64+
Attributes: map[string]schema.Attribute{
65+
names.AttrResourceARN: schema.StringAttribute{
66+
Description: "ARN of the Aurora Serverless cluster",
67+
Required: true,
68+
},
69+
"secret_arn": schema.StringAttribute{
70+
Description: "ARN of the Secrets Manager secret containing database credentials",
71+
Required: true,
72+
},
73+
"sql": schema.StringAttribute{
74+
Description: "SQL statement to execute",
75+
Required: true,
76+
},
77+
"database": schema.StringAttribute{
78+
Description: "Name of the database",
79+
Optional: true,
80+
},
81+
"include_result_metadata": schema.BoolAttribute{
82+
Description: "Include column metadata in query results",
83+
Optional: true,
84+
},
85+
},
86+
Blocks: map[string]schema.Block{
87+
"parameters": schema.ListNestedBlock{
88+
Description: "SQL parameters for prepared statements",
89+
CustomType: fwtypes.NewListNestedObjectTypeOf[sqlParameterModel](ctx),
90+
NestedObject: schema.NestedBlockObject{
91+
Attributes: map[string]schema.Attribute{
92+
names.AttrName: schema.StringAttribute{
93+
Description: "Parameter name",
94+
Required: true,
95+
},
96+
names.AttrValue: schema.StringAttribute{
97+
Description: "Parameter value",
98+
Required: true,
99+
},
100+
},
101+
},
102+
},
103+
},
104+
}
105+
}
106+
107+
func (a *queryAction) Configure(ctx context.Context, req action.ConfigureRequest, resp *action.ConfigureResponse) {
108+
if req.ProviderData == nil {
109+
return
110+
}
111+
112+
meta, ok := req.ProviderData.(*conns.AWSClient)
113+
if !ok {
114+
resp.Diagnostics.AddError(
115+
"Unexpected Action Configure Type",
116+
fmt.Sprintf("Expected *conns.AWSClient, got: %T", req.ProviderData),
117+
)
118+
return
119+
}
120+
121+
a.client = meta.RDSDataClient(ctx)
122+
}
123+
124+
func (a *queryAction) Invoke(ctx context.Context, req action.InvokeRequest, resp *action.InvokeResponse) {
125+
var model queryActionModel
126+
resp.Diagnostics.Append(req.Config.Get(ctx, &model)...)
127+
if resp.Diagnostics.HasError() {
128+
return
129+
}
130+
131+
tflog.Info(ctx, "Starting RDS Data query execution", map[string]any{
132+
"resource_arn": model.ResourceArn.ValueString(),
133+
"sql_length": len(model.SQL.ValueString()),
134+
})
135+
136+
resp.SendProgress(action.InvokeProgressEvent{
137+
Message: "Executing SQL query...",
138+
})
139+
140+
input := &rdsdata.ExecuteStatementInput{
141+
ResourceArn: aws.String(model.ResourceArn.ValueString()),
142+
SecretArn: aws.String(model.SecretArn.ValueString()),
143+
Sql: aws.String(model.SQL.ValueString()),
144+
}
145+
146+
if !model.Database.IsNull() {
147+
input.Database = aws.String(model.Database.ValueString())
148+
}
149+
150+
if !model.IncludeResultMetadata.IsNull() {
151+
input.IncludeResultMetadata = model.IncludeResultMetadata.ValueBool()
152+
}
153+
154+
if !model.Parameters.IsNull() {
155+
var params []sqlParameterModel
156+
resp.Diagnostics.Append(model.Parameters.ElementsAs(ctx, &params, false)...)
157+
if resp.Diagnostics.HasError() {
158+
return
159+
}
160+
161+
var sqlParams []types.SqlParameter
162+
for _, param := range params {
163+
sqlParams = append(sqlParams, types.SqlParameter{
164+
Name: aws.String(param.Name.ValueString()),
165+
Value: &types.FieldMemberStringValue{Value: param.Value.ValueString()},
166+
})
167+
}
168+
input.Parameters = sqlParams
169+
}
170+
171+
output, err := a.client.ExecuteStatement(ctx, input)
172+
if err != nil {
173+
resp.Diagnostics.AddError("SQL Execution Failed", err.Error())
174+
return
175+
}
176+
177+
resp.SendProgress(action.InvokeProgressEvent{
178+
Message: fmt.Sprintf("Query executed successfully. Records affected: %d", output.NumberOfRecordsUpdated),
179+
})
180+
181+
tflog.Info(ctx, "RDS Data query completed successfully", map[string]any{
182+
"records_updated": output.NumberOfRecordsUpdated,
183+
"has_records": len(output.Records) > 0,
184+
})
185+
}

‎internal/service/rdsdata/query_action_test.go‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
// Copyright (c) HashiCorp, Inc.
2+
// SPDX-License-Identifier: MPL-2.0
3+
4+
package rdsdata_test
5+
6+
import (
7+
"testing"
8+
9+
"github.com/hashicorp/terraform-plugin-testing/helper/resource"
10+
"github.com/hashicorp/terraform-provider-aws/internal/acctest"
11+
"github.com/hashicorp/terraform-provider-aws/names"
12+
)
13+
14+
func TestAccRDSDataQueryAction_basic(t *testing.T) {
15+
ctx := acctest.Context(t)
16+
rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix)
17+
18+
resource.ParallelTest(t, resource.TestCase{
19+
PreCheck: func() { acctest.PreCheck(ctx, t) },
20+
ErrorCheck: acctest.ErrorCheck(t, names.RDSDataServiceID),
21+
ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories,
22+
Steps: []resource.TestStep{
23+
{
24+
Config: testAccQueryActionConfig_basic(rName),
25+
},
26+
},
27+
})
28+
}
29+
30+
func testAccQueryActionConfig_basic(rName string) string {
31+
return acctest.ConfigCompose(testAccQueryDataSourceConfig_base(rName), `
32+
resource "aws_rdsdata_query" "test" {
33+
depends_on = [aws_rds_cluster_instance.test]
34+
resource_arn = aws_rds_cluster.test.arn
35+
secret_arn = aws_secretsmanager_secret_version.test.arn
36+
sql = "SELECT 1"
37+
}
38+
`)
39+
}

‎internal/service/rdsdata/service_package_gen.go‎

Lines changed: 11 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎website/docs/actions/rdsdata_query.html.markdown‎

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
---
2+
subcategory: "RDS (Relational Database)"
3+
layout: "aws"
4+
page_title: "AWS: aws_rdsdata_query"
5+
description: |-
6+
Executes SQL queries against Aurora Serverless databases using the RDS Data API.
7+
---
8+
9+
# Action: aws_rdsdata_query
10+
11+
~> **Note:** `aws_rdsdata_query` is in beta. Its interface and behavior may change as the feature evolves, and breaking changes are possible. It is offered as a technical preview without compatibility guarantees until Terraform 1.14 is generally available.
12+
13+
Executes SQL queries against Aurora Serverless databases using the RDS Data API. This action allows for imperative SQL execution with support for parameterized queries and transaction management.
14+
15+
For information about the RDS Data API, see the [RDS Data API Developer Guide](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html). For specific information about executing statements, see the [ExecuteStatement](https://docs.aws.amazon.com/rdsdataservice/latest/APIReference/API_ExecuteStatement.html) page in the RDS Data Service API Reference.
16+
17+
## Example Usage
18+
19+
### Basic Query
20+
21+
```terraform
22+
resource "aws_rds_cluster" "example" {
23+
cluster_identifier = "example-cluster"
24+
engine = "aurora-mysql"
25+
database_name = "example"
26+
master_username = "admin"
27+
master_password = "password123"
28+
enable_http_endpoint = true
29+
skip_final_snapshot = true
30+
31+
serverlessv2_scaling_configuration {
32+
max_capacity = 1
33+
min_capacity = 0.5
34+
}
35+
}
36+
37+
resource "aws_secretsmanager_secret" "example" {
38+
name = "example-db-credentials"
39+
}
40+
41+
resource "aws_secretsmanager_secret_version" "example" {
42+
secret_id = aws_secretsmanager_secret.example.id
43+
secret_string = jsonencode({
44+
username = aws_rds_cluster.example.master_username
45+
password = aws_rds_cluster.example.master_password
46+
})
47+
}
48+
49+
action "aws_rdsdata_query" "example" {
50+
config {
51+
resource_arn = aws_rds_cluster.example.arn
52+
secret_arn = aws_secretsmanager_secret_version.example.arn
53+
sql = "SELECT COUNT(*) FROM users"
54+
}
55+
}
56+
57+
resource "terraform_data" "example" {
58+
input = "trigger-query"
59+
60+
lifecycle {
61+
action_trigger {
62+
events = [before_create]
63+
actions = [action.aws_rdsdata_query.example]
64+
}
65+
}
66+
}
67+
```
68+
69+
### Parameterized Query
70+
71+
```terraform
72+
action "aws_rdsdata_query" "user_lookup" {
73+
config {
74+
resource_arn = aws_rds_cluster.example.arn
75+
secret_arn = aws_secretsmanager_secret_version.example.arn
76+
database = "example"
77+
sql = "SELECT * FROM users WHERE status = :status AND created_date > :date"
78+
79+
parameters {
80+
name = "status"
81+
value = "active"
82+
}
83+
84+
parameters {
85+
name = "date"
86+
value = "2024-01-01"
87+
}
88+
}
89+
}
90+
```
91+
92+
### Data Modification Query
93+
94+
```terraform
95+
action "aws_rdsdata_query" "update_status" {
96+
config {
97+
resource_arn = aws_rds_cluster.example.arn
98+
secret_arn = aws_secretsmanager_secret_version.example.arn
99+
database = "example"
100+
sql = "UPDATE users SET last_login = NOW() WHERE user_id = :user_id"
101+
102+
parameters {
103+
name = "user_id"
104+
value = "12345"
105+
}
106+
}
107+
}
108+
```
109+
110+
## Argument Reference
111+
112+
The following arguments are required:
113+
114+
* `resource_arn` - (Required) The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
115+
* `secret_arn` - (Required) The ARN of the secret that enables access to the DB cluster. The secret must contain the database credentials.
116+
* `sql` - (Required) The SQL statement to execute.
117+
118+
The following arguments are optional:
119+
120+
* `database` - (Optional) The name of the database to execute the SQL statement against.
121+
* `parameters` - (Optional) Parameters for the SQL statement. See [Parameters](#parameters) below.
122+
123+
### Parameters
124+
125+
The `parameters` block supports the following:
126+
127+
* `name` - (Required) The name of the parameter.
128+
* `value` - (Required) The value of the parameter.
129+
130+
## Attribute Reference
131+
132+
This action exports the following attributes:
133+
134+
* `records` - The records returned by the SQL statement (for SELECT queries).
135+
* `number_of_records_updated` - The number of records updated by the SQL statement (for INSERT, UPDATE, DELETE queries).
136+
137+
## Import
138+
139+
Actions cannot be imported.

0 commit comments

Comments
 (0)