Skip to content

Commit b2200a8

Browse files
authored
docs(rds): update deprecated InstanceProps example (#27499)
Updating example that uses deprecated `InstanceProps`. Also updating MySQL version for others as I got this error: `Cannot find version 5.7.mysql_aurora.2.08.1 for aurora-mysql`. Closes #27495. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent 8557c40 commit b2200a8

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

packages/aws-cdk-lib/aws-rds/README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ of readers (up to 15).
1818
```ts
1919
declare const vpc: ec2.Vpc;
2020
const cluster = new rds.DatabaseCluster(this, 'Database', {
21-
engine: rds.DatabaseClusterEngine.auroraMysql({ version: rds.AuroraMysqlEngineVersion.VER_2_08_1 }),
21+
engine: rds.DatabaseClusterEngine.auroraMysql({ version: rds.AuroraMysqlEngineVersion.VER_3_01_0 }),
2222
credentials: rds.Credentials.fromGeneratedSecret('clusteradmin'), // Optional - will default to 'admin' username and generated password
2323
writer: rds.ClusterInstance.provisioned('writer', {
2424
publiclyAccessible: false,
@@ -34,19 +34,24 @@ const cluster = new rds.DatabaseCluster(this, 'Database', {
3434
});
3535
```
3636

37-
To adopt Aurora I/O-Optimized. Specify `DBClusterStorageType.AURORA_IOPT1` on the `storageType` property.
37+
To adopt Aurora I/O-Optimized, specify `DBClusterStorageType.AURORA_IOPT1` on the `storageType` property.
3838

3939
```ts
4040
declare const vpc: ec2.Vpc;
4141
const cluster = new rds.DatabaseCluster(this, 'Database', {
4242
engine: rds.DatabaseClusterEngine.auroraPostgres({ version: rds.AuroraPostgresEngineVersion.VER_15_2 }),
4343
credentials: rds.Credentials.fromUsername('adminuser', { password: SecretValue.unsafePlainText('7959866cacc02c2d243ecfe177464fe6') }),
44-
instanceProps: {
45-
instanceType: ec2.InstanceType.of(ec2.InstanceClass.X2G, ec2.InstanceSize.XLARGE),
46-
vpcSubnets: { subnetType: ec2.SubnetType.PUBLIC },
47-
vpc,
48-
},
44+
writer: rds.ClusterInstance.provisioned('writer', {
45+
publiclyAccessible: false,
46+
}),
47+
readers: [
48+
rds.ClusterInstance.provisioned('reader')
49+
],
4950
storageType: rds.DBClusterStorageType.AURORA_IOPT1,
51+
vpcSubnets: {
52+
subnetType: ec2.SubnetType.PRIVATE_WITH_EGRESS,
53+
},
54+
vpc,
5055
});
5156
```
5257

@@ -220,7 +225,7 @@ scaled to handle the write load.
220225
```ts
221226
declare const vpc: ec2.Vpc;
222227
const cluster = new rds.DatabaseCluster(this, 'Database', {
223-
engine: rds.DatabaseClusterEngine.auroraMysql({ version: rds.AuroraMysqlEngineVersion.VER_2_08_1 }),
228+
engine: rds.DatabaseClusterEngine.auroraMysql({ version: rds.AuroraMysqlEngineVersion.VER_3_01_0 }),
224229
writer: rds.ClusterInstance.serverlessV2('writer'),
225230
readers: [
226231
// will be put in promotion tier 1 and will scale with the writer
@@ -269,7 +274,7 @@ a higher minimum capacity.
269274
```ts
270275
declare const vpc: ec2.Vpc;
271276
const cluster = new rds.DatabaseCluster(this, 'Database', {
272-
engine: rds.DatabaseClusterEngine.auroraMysql({ version: rds.AuroraMysqlEngineVersion.VER_2_08_1 }),
277+
engine: rds.DatabaseClusterEngine.auroraMysql({ version: rds.AuroraMysqlEngineVersion.VER_3_01_0 }),
273278
writer: rds.ClusterInstance.provisioned('writer', {
274279
instanceType: ec2.InstanceType.of(ec2.InstanceClass.R6G, ec2.InstanceSize.XLARGE4),
275280
}),

0 commit comments

Comments
 (0)