Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions compatibility-tests/sdk-test-awscli/test/rds.bats
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,14 @@ setup() {
DB_ID="bats-rds-$(unique_name)"
DB_ID_2="bats-rds-2-$(unique_name)"
RDS_CLUSTER_ID="bats-rds-cluster-$(unique_name)"
PROXY_NAME="bats-proxy-$(unique_name)"
}

teardown() {
aws_cmd rds delete-db-instance --db-instance-identifier "$DB_ID" --skip-final-snapshot >/dev/null 2>&1 || true
aws_cmd rds delete-db-instance --db-instance-identifier "$DB_ID_2" --skip-final-snapshot >/dev/null 2>&1 || true
aws_cmd rds delete-db-cluster --db-cluster-identifier "$RDS_CLUSTER_ID" --skip-final-snapshot >/dev/null 2>&1 || true
aws_cmd rds delete-db-proxy --db-proxy-name "$PROXY_NAME" >/dev/null 2>&1 || true
if [ -n "${MANAGED_SECRET_ARN:-}" ]; then
aws_cmd secretsmanager delete-secret --secret-id "$MANAGED_SECRET_ARN" \
--force-delete-without-recovery >/dev/null 2>&1 || true
Expand Down Expand Up @@ -432,3 +434,41 @@ teardown() {
assert_failure
assert_output --partial 'InvalidParameterValue'
}

@test "rds: a proxy endpoint is added, renamed and deleted" {
run aws_cmd ec2 describe-subnets --query 'Subnets[?DefaultForAz].SubnetId'
assert_success
subnet_a=$(json_get "$output" '.[0]')
subnet_b=$(json_get "$output" '.[1]')

run aws_cmd rds create-db-proxy --db-proxy-name "$PROXY_NAME" --engine-family POSTGRESQL \
--role-arn arn:aws:iam::000000000000:role/rds-proxy \
--vpc-subnet-ids "$subnet_a" "$subnet_b" \
--auth AuthScheme=SECRETS,SecretArn=arn:aws:secretsmanager:us-east-1:000000000000:secret:db-AbCdEf
assert_success

reader="$PROXY_NAME-reader"
run aws_cmd rds create-db-proxy-endpoint --db-proxy-name "$PROXY_NAME" \
--db-proxy-endpoint-name "$reader" --vpc-subnet-ids "$subnet_a" "$subnet_b" --target-role READ_ONLY
assert_success
[ "$(json_get "$output" '.DBProxyEndpoint.TargetRole')" = "READ_ONLY" ]
[ "$(json_get "$output" '.DBProxyEndpoint.IsDefault')" = "false" ]

run aws_cmd rds describe-db-proxy-endpoints --db-proxy-name "$PROXY_NAME"
assert_success
[ "$(json_get "$output" '.DBProxyEndpoints[0].DBProxyEndpointName')" = "default" ]
[ "$(json_get "$output" '.DBProxyEndpoints[0].IsDefault')" = "true" ]
[ "$(json_get "$output" '.DBProxyEndpoints[1].DBProxyEndpointName')" = "$reader" ]

renamed="$PROXY_NAME-analytics"
run aws_cmd rds modify-db-proxy-endpoint --db-proxy-endpoint-name "$reader" \
--new-db-proxy-endpoint-name "$renamed"
assert_success
[ "$(json_get "$output" '.DBProxyEndpoint.DBProxyEndpointName')" = "$renamed" ]

run aws_cmd rds delete-db-proxy-endpoint --db-proxy-endpoint-name "$renamed"
assert_success
run aws_cmd rds delete-db-proxy-endpoint --db-proxy-endpoint-name "$renamed"
assert_failure
assert_output --partial 'DBProxyEndpointNotFoundFault'
}
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
import software.amazon.awssdk.services.rds.model.CreateDbClusterEndpointResponse;
import software.amazon.awssdk.services.rds.model.CreateDbClusterResponse;
import software.amazon.awssdk.services.rds.model.CreateDbInstanceResponse;
import software.amazon.awssdk.services.rds.model.CreateDbProxyEndpointResponse;
import software.amazon.awssdk.services.rds.model.CreateDbProxyResponse;
import software.amazon.awssdk.services.rds.model.CreateDbSubnetGroupResponse;
import software.amazon.awssdk.services.rds.model.CreateOptionGroupResponse;
Expand All @@ -25,6 +26,7 @@
import software.amazon.awssdk.services.rds.model.DBEngineVersion;
import software.amazon.awssdk.services.rds.model.DBInstance;
import software.amazon.awssdk.services.rds.model.DBInstanceRole;
import software.amazon.awssdk.services.rds.model.DBProxyEndpointTargetRole;
import software.amazon.awssdk.services.rds.model.DBProxyTarget;
import software.amazon.awssdk.services.rds.model.DBSnapshot;
import software.amazon.awssdk.services.rds.model.DbClusterEndpointAlreadyExistsException;
Expand All @@ -35,10 +37,12 @@
import software.amazon.awssdk.services.rds.model.DbInstanceRoleAlreadyExistsException;
import software.amazon.awssdk.services.rds.model.DbInstanceRoleNotFoundException;
import software.amazon.awssdk.services.rds.model.DbLogFileNotFoundException;
import software.amazon.awssdk.services.rds.model.DbProxyEndpointNotFoundException;
import software.amazon.awssdk.services.rds.model.DbSnapshotAlreadyExistsException;
import software.amazon.awssdk.services.rds.model.DbSnapshotNotFoundException;
import software.amazon.awssdk.services.rds.model.DescribeDBLogFilesDetails;
import software.amazon.awssdk.services.rds.model.DescribeDbProxiesResponse;
import software.amazon.awssdk.services.rds.model.DescribeDbProxyEndpointsResponse;
import software.amazon.awssdk.services.rds.model.DescribeDbProxyTargetGroupsResponse;
import software.amazon.awssdk.services.rds.model.DescribeDbProxyTargetsResponse;
import software.amazon.awssdk.services.rds.model.DescribeDbSubnetGroupsResponse;
Expand All @@ -47,11 +51,13 @@
import software.amazon.awssdk.services.rds.model.DownloadDbLogFilePortionResponse;
import software.amazon.awssdk.services.rds.model.EngineDefaults;
import software.amazon.awssdk.services.rds.model.InvalidDbInstanceStateException;
import software.amazon.awssdk.services.rds.model.InvalidDbProxyEndpointStateException;
import software.amazon.awssdk.services.rds.model.InvalidOptionGroupStateException;
import software.amazon.awssdk.services.rds.model.InvalidRestoreException;
import software.amazon.awssdk.services.rds.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.rds.model.ModifyDbClusterEndpointResponse;
import software.amazon.awssdk.services.rds.model.ModifyDbClusterResponse;
import software.amazon.awssdk.services.rds.model.ModifyDbProxyEndpointResponse;
import software.amazon.awssdk.services.rds.model.ModifyDbProxyResponse;
import software.amazon.awssdk.services.rds.model.ModifyDbProxyTargetGroupResponse;
import software.amazon.awssdk.services.rds.model.ModifyOptionGroupResponse;
Expand Down Expand Up @@ -317,6 +323,56 @@ void sdkRoundTripsIamDefaultAuthAndProxyUpdates() {
}
}

@Test
void sdkRoundTripsDbProxyEndpoints() {
String proxyName = TestFixtures.uniqueName("rds-proxy-endpoints");
String endpointName = TestFixtures.uniqueName("reader");
String renamed = TestFixtures.uniqueName("analytics");
try {
CreateDbProxyResponse proxy = rds.createDBProxy(b -> b
.dbProxyName(proxyName)
.engineFamily("POSTGRESQL")
.roleArn("arn:aws:iam::000000000000:role/rds-proxy")
.vpcSubnetIds(subnetIds)
.auth(a -> a.authScheme("SECRETS")
.secretArn("arn:aws:secretsmanager:us-east-1:000000000000:secret:db-AbCdEf")));

CreateDbProxyEndpointResponse created = rds.createDBProxyEndpoint(b -> b
.dbProxyName(proxyName)
.dbProxyEndpointName(endpointName)
.vpcSubnetIds(subnetIds)
.vpcSecurityGroupIds("sg-endpoint")
.targetRole(DBProxyEndpointTargetRole.READ_ONLY)
.tags(t -> t.key("team").value("data")));
assertThat(created.dbProxyEndpoint().targetRole()).isEqualTo(DBProxyEndpointTargetRole.READ_ONLY);
assertThat(created.dbProxyEndpoint().isDefault()).isFalse();
assertThat(created.dbProxyEndpoint().endpoint()).isEqualTo(proxy.dbProxy().endpoint());
assertThat(created.dbProxyEndpoint().createdDate()).isNotNull();
assertThat(rds.listTagsForResource(b -> b.resourceName(created.dbProxyEndpoint().dbProxyEndpointArn()))
.tagList()).extracting("key").containsExactly("team");

DescribeDbProxyEndpointsResponse described = rds.describeDBProxyEndpoints(b -> b.dbProxyName(proxyName));
assertThat(described.dbProxyEndpoints()).extracting("dbProxyEndpointName")
.containsExactly("default", endpointName);
assertThat(described.dbProxyEndpoints().get(0).isDefault()).isTrue();

ModifyDbProxyEndpointResponse modified = rds.modifyDBProxyEndpoint(b -> b
.dbProxyEndpointName(endpointName)
.newDBProxyEndpointName(renamed)
.vpcSecurityGroupIds("sg-other"));
assertThat(modified.dbProxyEndpoint().dbProxyEndpointName()).isEqualTo(renamed);
assertThat(modified.dbProxyEndpoint().vpcSecurityGroupIds()).containsExactly("sg-other");

assertThatThrownBy(() -> rds.deleteDBProxyEndpoint(b -> b.dbProxyEndpointName("default")))
.isInstanceOf(InvalidDbProxyEndpointStateException.class);
rds.deleteDBProxyEndpoint(b -> b.dbProxyEndpointName(renamed));
assertThatThrownBy(() -> rds.describeDBProxyEndpoints(b -> b.dbProxyEndpointName(renamed)))
.isInstanceOf(DbProxyEndpointNotFoundException.class);
} finally {
deleteProxy(rds, proxyName);
}
}

@Test
void sdkScopesTheSameDbProxyNameBySignedRegion() {
String regionalProxyName = TestFixtures.uniqueName("rds-proxy-regional");
Expand Down
2 changes: 1 addition & 1 deletion docs/services/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Operation counts are exact. For dispatch-table services (Query and JSON 1.1) eac
| [ElastiCache](elasticache.md) | `POST /` with `Action=` param + TCP proxy | Query + RESP | 30 |
| [MemoryDB](memorydb.md) | `POST /` + `X-Amz-Target: AmazonMemoryDB.*` + TCP proxy | JSON 1.1 + RESP | 13 |
| [Aurora DSQL](dsql.md) | `/cluster`, `/cluster/{identifier}`, `/cluster/{identifier}/policy` | REST JSON | 9 |
| [RDS](rds.md) | `POST /` with `Action=` param + TCP proxy | Query + wire | 105 |
| [RDS](rds.md) | `POST /` with `Action=` param + TCP proxy | Query + wire | 109 |
| [RDS Data API](rds-data.md) | `/Execute`, `/BeginTransaction`, `/CommitTransaction`, `/RollbackTransaction` | REST JSON | 4 |
| [Timestream for InfluxDB](timestream-influxdb.md) | `POST /` + `X-Amz-Target: AmazonTimestreamInfluxDB.*` + InfluxDB container | JSON 1.0 + InfluxDB HTTP | 24 |
| [MSK](msk.md) | `/v1/clusters/...`, `/api/v2/clusters/...` + Redpanda broker | REST JSON + Kafka | 8 |
Expand Down
15 changes: 14 additions & 1 deletion docs/services/rds.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,11 @@ RDS Data API (`rds-data`) is documented separately because it uses REST JSON rou
| `DescribeDBProxies` | List DB proxies |
| `CreateDBProxy` | Create a DB proxy |
| `ModifyDBProxy` | Update mutable DB proxy authentication, logging, timeout, TLS, role, and security-group settings |
| `DeleteDBProxy` | Delete a DB proxy |
| `DeleteDBProxy` | Delete a DB proxy and its endpoints |
| `CreateDBProxyEndpoint` | Add a read/write or read-only endpoint to a DB proxy; see the proxy note below |
| `DescribeDBProxyEndpoints` | List proxy endpoints, each proxy's default endpoint first, filtered by `DBProxyName` and `DBProxyEndpointName` |
| `ModifyDBProxyEndpoint` | Rename a proxy endpoint or replace its security groups |
| `DeleteDBProxyEndpoint` | Delete a proxy endpoint |
| `RegisterDBProxyTargets` | Register a cluster or instance as a proxy target |
| `DeregisterDBProxyTargets` | Remove a cluster or instance from a proxy target group |
| `DescribeDBProxyTargetGroups` | List a proxy's target groups |
Expand Down Expand Up @@ -346,6 +350,15 @@ services:
is rejected with `InvalidParameterValue` unless the proxy's VPC and every subnet in
`VpcSubnetIds` already carry an associated IPv6 CIDR block, matching AWS's own network
prerequisites for RDS Proxy.
Proxy endpoints report the proxy's own host, so a client connects through one as through the
proxy, and an IAM token signed for that host verifies there. The host is read from the proxy
for each response, so when a restore gives the proxy a new host every endpoint reports it. `TargetRole` is recorded: Floci
proxies have one target, so a `READ_ONLY` endpoint reaches the same target as the proxy rather
than an Aurora reader. Each proxy's default endpoint (`default`, `IsDefault` true, `READ_WRITE`)
is built from the proxy, has no ARN, and cannot be modified or deleted
(`InvalidDBProxyEndpointStateFault`). Endpoint names are unique per account and Region, a proxy
holds at most 20 endpoints (`DBProxyEndpointQuotaExceededFault`), and an endpoint with no
`VpcSecurityGroupIds` gets its VPC's default security group.

## Aurora Serverless v2 scaling

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import io.github.hectorvent.floci.services.rds.model.DbParameterGroup;
import io.github.hectorvent.floci.services.rds.model.DbProxy;
import io.github.hectorvent.floci.services.rds.model.DbProxyAuth;
import io.github.hectorvent.floci.services.rds.model.DbProxyEndpoint;
import io.github.hectorvent.floci.services.rds.model.DbProxyTarget;
import io.github.hectorvent.floci.services.rds.model.DbProxyTargetGroup;
import io.github.hectorvent.floci.services.rds.model.DbRoleAssociation;
Expand Down Expand Up @@ -169,6 +170,10 @@ public Response handle(String action, MultivaluedMap<String, String> params, Str
case "CreateDBProxy" -> handleCreateDbProxy(params, region);
case "ModifyDBProxy" -> handleModifyDbProxy(params, region);
case "DeleteDBProxy" -> handleDeleteDbProxy(params, region);
case "CreateDBProxyEndpoint" -> handleCreateDbProxyEndpoint(params, region);
case "DescribeDBProxyEndpoints" -> handleDescribeDbProxyEndpoints(params, region);
case "ModifyDBProxyEndpoint" -> handleModifyDbProxyEndpoint(params, region);
case "DeleteDBProxyEndpoint" -> handleDeleteDbProxyEndpoint(params, region);
case "RegisterDBProxyTargets" -> handleRegisterDbProxyTargets(params, region);
case "DeregisterDBProxyTargets" -> handleDeregisterDbProxyTargets(params, region);
case "DescribeDBProxyTargetGroups" -> handleDescribeDbProxyTargetGroups(params, region);
Expand Down Expand Up @@ -2205,6 +2210,84 @@ private Response handleDeleteDbProxy(MultivaluedMap<String, String> params, Stri
return Response.ok(AwsQueryResponse.envelope("DeleteDBProxy", AwsNamespaces.RDS, result)).build();
}

private Response handleCreateDbProxyEndpoint(MultivaluedMap<String, String> params, String region) {
DbProxyEndpoint endpoint = service.createDbProxyEndpoint(region,
params.getFirst("DBProxyName"),
params.getFirst("DBProxyEndpointName"),
memberList(params, "VpcSubnetIds"),
memberList(params, "VpcSecurityGroupIds"),
params.getFirst("TargetRole"),
params.getFirst("EndpointNetworkType"),
parseTags(params));
return Response.ok(AwsQueryResponse.envelope("CreateDBProxyEndpoint", AwsNamespaces.RDS,
dbProxyEndpointXml(endpoint))).build();
}

private Response handleDescribeDbProxyEndpoints(MultivaluedMap<String, String> params, String region) {
RdsService.ProxyEndpointPage page = service.describeDbProxyEndpoints(region,
params.getFirst("DBProxyName"),
params.getFirst("DBProxyEndpointName"),
optionalInt(params.getFirst("MaxRecords")),
params.getFirst("Marker"));
XmlBuilder xml = new XmlBuilder().start("DBProxyEndpoints");
for (DbProxyEndpoint endpoint : page.endpoints()) {
xml.start("member").raw(dbProxyEndpointInnerXml(endpoint)).end("member");
}
xml.end("DBProxyEndpoints");
if (page.marker() != null) {
xml.elem("Marker", page.marker());
}
return Response.ok(AwsQueryResponse.envelope("DescribeDBProxyEndpoints", AwsNamespaces.RDS,
xml.build())).build();
}

private Response handleModifyDbProxyEndpoint(MultivaluedMap<String, String> params, String region) {
// Security groups left out of the request are kept; a list given replaces them.
DbProxyEndpoint endpoint = service.modifyDbProxyEndpoint(region,
params.getFirst("DBProxyEndpointName"),
params.getFirst("NewDBProxyEndpointName"),
hasMemberKeys(params, "VpcSecurityGroupIds") ? memberList(params, "VpcSecurityGroupIds") : null);
return Response.ok(AwsQueryResponse.envelope("ModifyDBProxyEndpoint", AwsNamespaces.RDS,
dbProxyEndpointXml(endpoint))).build();
}

private Response handleDeleteDbProxyEndpoint(MultivaluedMap<String, String> params, String region) {
DbProxyEndpoint endpoint = service.deleteDbProxyEndpoint(region, params.getFirst("DBProxyEndpointName"));
return Response.ok(AwsQueryResponse.envelope("DeleteDBProxyEndpoint", AwsNamespaces.RDS,
dbProxyEndpointXml(endpoint))).build();
}

private static String dbProxyEndpointXml(DbProxyEndpoint e) {
return new XmlBuilder().start("DBProxyEndpoint").raw(dbProxyEndpointInnerXml(e)).end("DBProxyEndpoint").build();
}

/** The DBProxyEndpoint members; a proxy's default endpoint has no ARN. */
private static String dbProxyEndpointInnerXml(DbProxyEndpoint e) {
XmlBuilder xml = new XmlBuilder().elem("DBProxyEndpointName", e.getDbProxyEndpointName());
if (e.getDbProxyEndpointArn() != null) {
xml.elem("DBProxyEndpointArn", e.getDbProxyEndpointArn());
}
xml.elem("DBProxyName", e.getDbProxyName())
.elem("Status", e.getStatus());
if (e.getVpcId() != null) {
xml.elem("VpcId", e.getVpcId());
}
xml.start("VpcSecurityGroupIds");
e.getVpcSecurityGroupIds().forEach(id -> xml.elem("member", id));
xml.end("VpcSecurityGroupIds");
xml.start("VpcSubnetIds");
e.getVpcSubnetIds().forEach(id -> xml.elem("member", id));
xml.end("VpcSubnetIds");
xml.elem("Endpoint", e.getEndpoint());
if (e.getCreatedDate() != null) {
xml.elem("CreatedDate", e.getCreatedDate().toString());
}
xml.elem("TargetRole", e.getTargetRole())
.elem("IsDefault", String.valueOf(e.isDefault()))
.elem("EndpointNetworkType", e.getEndpointNetworkType() != null ? e.getEndpointNetworkType() : "IPV4");
return xml.build();
}

private Response handleRegisterDbProxyTargets(MultivaluedMap<String, String> params, String region) {
String name = params.getFirst("DBProxyName");
String tgName = params.getFirst("TargetGroupName");
Expand Down
Loading
Loading