Skip to content

Commit 7cfaf82

Browse files
committed
Deploying to gh-pages from @ 94cbbeb 🚀
1 parent 0c9e641 commit 7cfaf82

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

index.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -765,6 +765,7 @@ Any object.
765765
| <code><a href="#eoapi-cdk.PgStacDatabase.property.connectionTarget">connectionTarget</a></code> | <code>aws-cdk-lib.aws_ec2.Instance \| aws-cdk-lib.aws_rds.IDatabaseInstance</code> | *No description.* |
766766
| <code><a href="#eoapi-cdk.PgStacDatabase.property.pgstacVersion">pgstacVersion</a></code> | <code>string</code> | *No description.* |
767767
| <code><a href="#eoapi-cdk.PgStacDatabase.property.pgbouncerHealthCheck">pgbouncerHealthCheck</a></code> | <code>aws-cdk-lib.CustomResource</code> | *No description.* |
768+
| <code><a href="#eoapi-cdk.PgStacDatabase.property.pgbouncerInstanceId">pgbouncerInstanceId</a></code> | <code>string</code> | *No description.* |
768769
| <code><a href="#eoapi-cdk.PgStacDatabase.property.secretBootstrapper">secretBootstrapper</a></code> | <code>aws-cdk-lib.CustomResource</code> | *No description.* |
769770
| <code><a href="#eoapi-cdk.PgStacDatabase.property.securityGroup">securityGroup</a></code> | <code>aws-cdk-lib.aws_ec2.SecurityGroup</code> | *No description.* |
770771
| <code><a href="#eoapi-cdk.PgStacDatabase.property.db">db</a></code> | <code>aws-cdk-lib.aws_rds.DatabaseInstance</code> | *No description.* |
@@ -814,6 +815,16 @@ public readonly pgbouncerHealthCheck: CustomResource;
814815

815816
---
816817

818+
##### `pgbouncerInstanceId`<sup>Optional</sup> <a name="pgbouncerInstanceId" id="eoapi-cdk.PgStacDatabase.property.pgbouncerInstanceId"></a>
819+
820+
```typescript
821+
public readonly pgbouncerInstanceId: string;
822+
```
823+
824+
- *Type:* string
825+
826+
---
827+
817828
##### `secretBootstrapper`<sup>Optional</sup> <a name="secretBootstrapper" id="eoapi-cdk.PgStacDatabase.property.secretBootstrapper"></a>
818829

819830
```typescript
@@ -3623,10 +3634,12 @@ const pgStacDatabaseProps: PgStacDatabaseProps = { ... }
36233634
| <code><a href="#eoapi-cdk.PgStacDatabaseProps.property.credentials">credentials</a></code> | <code>aws-cdk-lib.aws_rds.Credentials</code> | Credentials for the administrative user. |
36243635
| <code><a href="#eoapi-cdk.PgStacDatabaseProps.property.storageEncrypted">storageEncrypted</a></code> | <code>boolean</code> | Indicates whether the DB instance is encrypted. |
36253636
| <code><a href="#eoapi-cdk.PgStacDatabaseProps.property.storageEncryptionKey">storageEncryptionKey</a></code> | <code>aws-cdk-lib.aws_kms.IKeyRef</code> | The KMS key that's used to encrypt the DB instance. |
3637+
| <code><a href="#eoapi-cdk.PgStacDatabaseProps.property.addPatchManager">addPatchManager</a></code> | <code>boolean</code> | Add patching system using AWS SSM for pgbouncer instance maintenance `addPgbouncer` must be true for this to have an effect. |
36263638
| <code><a href="#eoapi-cdk.PgStacDatabaseProps.property.addPgbouncer">addPgbouncer</a></code> | <code>boolean</code> | Add pgbouncer instance for managing traffic to the pgSTAC database. |
36273639
| <code><a href="#eoapi-cdk.PgStacDatabaseProps.property.bootstrapperLambdaFunctionOptions">bootstrapperLambdaFunctionOptions</a></code> | <code>any</code> | Can be used to override the default lambda function properties. |
36283640
| <code><a href="#eoapi-cdk.PgStacDatabaseProps.property.customResourceProperties">customResourceProperties</a></code> | <code>{[ key: string ]: any}</code> | Lambda function Custom Resource properties. |
36293641
| <code><a href="#eoapi-cdk.PgStacDatabaseProps.property.forceBootstrap">forceBootstrap</a></code> | <code>boolean</code> | Force redeployment of the database bootstrapper Lambda on every deploy. |
3642+
| <code><a href="#eoapi-cdk.PgStacDatabaseProps.property.maintenanceWindow">maintenanceWindow</a></code> | <code>aws-cdk-lib.aws_ssm.CfnMaintenanceWindow</code> | Custom maintenance window for patching. |
36303643
| <code><a href="#eoapi-cdk.PgStacDatabaseProps.property.pgbouncerInstanceProps">pgbouncerInstanceProps</a></code> | <code>any</code> | Properties for the pgbouncer ec2 instance. |
36313644
| <code><a href="#eoapi-cdk.PgStacDatabaseProps.property.pgstacDbName">pgstacDbName</a></code> | <code>string</code> | Name of database that is to be created and onto which pgSTAC will be installed. |
36323645
| <code><a href="#eoapi-cdk.PgStacDatabaseProps.property.pgstacUsername">pgstacUsername</a></code> | <code>string</code> | Name of user that will be generated for connecting to the pgSTAC database. |
@@ -4454,6 +4467,19 @@ The KMS key that's used to encrypt the DB instance.
44544467

44554468
---
44564469

4470+
##### `addPatchManager`<sup>Optional</sup> <a name="addPatchManager" id="eoapi-cdk.PgStacDatabaseProps.property.addPatchManager"></a>
4471+
4472+
```typescript
4473+
public readonly addPatchManager: boolean;
4474+
```
4475+
4476+
- *Type:* boolean
4477+
- *Default:* true
4478+
4479+
Add patching system using AWS SSM for pgbouncer instance maintenance `addPgbouncer` must be true for this to have an effect.
4480+
4481+
---
4482+
44574483
##### `addPgbouncer`<sup>Optional</sup> <a name="addPgbouncer" id="eoapi-cdk.PgStacDatabaseProps.property.addPgbouncer"></a>
44584484

44594485
```typescript
@@ -4521,6 +4547,19 @@ control over when redeployment happens.
45214547

45224548
---
45234549

4550+
##### `maintenanceWindow`<sup>Optional</sup> <a name="maintenanceWindow" id="eoapi-cdk.PgStacDatabaseProps.property.maintenanceWindow"></a>
4551+
4552+
```typescript
4553+
public readonly maintenanceWindow: CfnMaintenanceWindow;
4554+
```
4555+
4556+
- *Type:* aws-cdk-lib.aws_ssm.CfnMaintenanceWindow
4557+
- *Default:* A new maintenance window will be created, defined in construct
4558+
4559+
Custom maintenance window for patching.
4560+
4561+
---
4562+
45244563
##### `pgbouncerInstanceProps`<sup>Optional</sup> <a name="pgbouncerInstanceProps" id="eoapi-cdk.PgStacDatabaseProps.property.pgbouncerInstanceProps"></a>
45254564

45264565
```typescript

0 commit comments

Comments
 (0)