Skip to content

Commit

Permalink
chore: refresh jsii
Browse files Browse the repository at this point in the history
  • Loading branch information
@dpilch
dpilch committed Oct 22, 2024
1 parent c3c9e5e commit 1d2768e
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
4 changes: 2 additions & 2 deletions packages/amplify-database-construct/.jsii
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3888,7 +3888,7 @@
},
"name": "@aws-amplify/database-construct",
"readme": {
"markdown": "# Amplify Database Construct\n\n[![View on Construct Hub](https://constructs.dev/badge?package=%40aws-amplify%2Fdatabase-construct)](https://constructs.dev/packages/@aws-amplify/database-construct)\n\n\nThis package vends an L3 CDK Construct to create a Aurora DB cluster for the Amplify GraphQL API.\n\n## Examples\n\n### Basic Example\n\nTODO\n\n```ts\nimport { AmplifyDatabaseCluster } from '@aws-amplify/database-construct';\nimport { AmplifyGraphQLAPI } from '@aws-amplify/graphql-api-construct';\n\nconst databaseCluster = new AmplifyDatabaseCluster({\n dbType: 'POSTGRES',\n});\n\nconst dbManager = AmplifyDatabaseManager({\n databaseCluster,\n});\n\ndbManager.sqlStatment('create Todo table sql statement');\n\nconst schema = `\n type Todo @model {\n content: String\n }\n`;\n\nnew AmplifyGraphQLAPI({\n definition: AmplifyGraphqlDefinition.fromString(\n // graphql schema needs to match databaseCluster sql schema\n // gen 2 will provide compile time type checking\n schema,\n databaseCluster.dataSourceStrategy\n ),\n});\n```\n"
"markdown": "# Amplify Database Construct\n\n[![View on Construct Hub](https://constructs.dev/badge?package=%40aws-amplify%2Fdatabase-construct)](https://constructs.dev/packages/@aws-amplify/database-construct)\n\nThis package vends an L3 CDK Construct to create a Aurora DB cluster for the Amplify GraphQL API.\n\n## Examples\n\n### Basic Example\n\nTODO\n\n```ts\nimport { AmplifyDatabaseCluster } from '@aws-amplify/database-construct';\nimport { AmplifyGraphQLAPI } from '@aws-amplify/graphql-api-construct';\n\nconst databaseCluster = new AmplifyDatabaseCluster({\n dbType: 'POSTGRES',\n});\n\nconst dbManager = AmplifyDatabaseManager({\n databaseCluster,\n});\n\ndbManager.sqlStatment('create Todo table sql statement');\n\nconst schema = `\n type Todo @model {\n content: String\n }\n`;\n\nnew AmplifyGraphQLAPI({\n definition: AmplifyGraphqlDefinition.fromString(\n // graphql schema needs to match databaseCluster sql schema\n // gen 2 will provide compile time type checking\n schema,\n databaseCluster.dataSourceStrategy,\n ),\n});\n```\n\n# API Reference <a name=\"API Reference\" id=\"api-reference\"></a>\n\n## Constructs <a name=\"Constructs\" id=\"Constructs\"></a>\n\n### AmplifyDatabase <a name=\"AmplifyDatabase\" id=\"@aws-amplify/database-construct.AmplifyDatabase\"></a>\n\n#### Initializers <a name=\"Initializers\" id=\"@aws-amplify/database-construct.AmplifyDatabase.Initializer\"></a>\n\n```typescript\nimport { AmplifyDatabase } from '@aws-amplify/database-construct'\n\nnew AmplifyDatabase(scope: Construct, id: string, props: AmplifyDatabaseProps)\n```\n\n| **Name** | **Type** | **Description** |\n| ------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------- |\n| <code><a href=\"#@aws-amplify/database-construct.AmplifyDatabase.Initializer.parameter.scope\">scope</a></code> | <code>constructs.Construct</code> | _No description._ |\n| <code><a href=\"#@aws-amplify/database-construct.AmplifyDatabase.Initializer.parameter.id\">id</a></code> | <code>string</code> | _No description._ |\n| <code><a href=\"#@aws-amplify/database-construct.AmplifyDatabase.Initializer.parameter.props\">props</a></code> | <code><a href=\"#@aws-amplify/database-construct.AmplifyDatabaseProps\">AmplifyDatabaseProps</a></code> | _No description._ |\n\n---\n\n##### `scope`<sup>Required</sup> <a name=\"scope\" id=\"@aws-amplify/database-construct.AmplifyDatabase.Initializer.parameter.scope\"></a>\n\n- _Type:_ constructs.Construct\n\n---\n\n##### `id`<sup>Required</sup> <a name=\"id\" id=\"@aws-amplify/database-construct.AmplifyDatabase.Initializer.parameter.id\"></a>\n\n- _Type:_ string\n\n---\n\n##### `props`<sup>Required</sup> <a name=\"props\" id=\"@aws-amplify/database-construct.AmplifyDatabase.Initializer.parameter.props\"></a>\n\n- _Type:_ <a href=\"#@aws-amplify/database-construct.AmplifyDatabaseProps\">AmplifyDatabaseProps</a>\n\n---\n\n#### Methods <a name=\"Methods\" id=\"Methods\"></a>\n\n| **Name** | **Description** |\n| --------------------------------------------------------------------------------------------- | -------------------------------------------------- |\n| <code><a href=\"#@aws-amplify/database-construct.AmplifyDatabase.toString\">toString</a></code> | Returns a string representation of this construct. |\n\n---\n\n##### `toString` <a name=\"toString\" id=\"@aws-amplify/database-construct.AmplifyDatabase.toString\"></a>\n\n```typescript\npublic toString(): string\n```\n\nReturns a string representation of this construct.\n\n#### Static Functions <a name=\"Static Functions\" id=\"Static Functions\"></a>\n\n| **Name** | **Description** |\n| --------------------------------------------------------------------------------------------------- | ----------------------------- |\n| <code><a href=\"#@aws-amplify/database-construct.AmplifyDatabase.isConstruct\">isConstruct</a></code> | Checks if `x` is a construct. |\n\n---\n\n##### `isConstruct` <a name=\"isConstruct\" id=\"@aws-amplify/database-construct.AmplifyDatabase.isConstruct\"></a>\n\n```typescript\nimport { AmplifyDatabase } from '@aws-amplify/database-construct'\n\nAmplifyDatabase.isConstruct(x: any)\n```\n\nChecks if `x` is a construct.\n\nUse this method instead of `instanceof` to properly detect `Construct`\ninstances, even when the construct library is symlinked.\n\nExplanation: in JavaScript, multiple copies of the `constructs` library on\ndisk are seen as independent, completely different libraries. As a\nconsequence, the class `Construct` in each copy of the `constructs` library\nis seen as a different class, and an instance of one class will not test as\n`instanceof` the other class. `npm install` will not create installations\nlike this, but users may manually symlink construct libraries together or\nuse a monorepo tool: in those cases, multiple copies of the `constructs`\nlibrary can be accidentally installed, and `instanceof` will behave\nunpredictably. It is safest to avoid using `instanceof`, and using\nthis type-testing method instead.\n\n###### `x`<sup>Required</sup> <a name=\"x\" id=\"@aws-amplify/database-construct.AmplifyDatabase.isConstruct.parameter.x\"></a>\n\n- _Type:_ any\n\nAny object.\n\n---\n\n#### Properties <a name=\"Properties\" id=\"Properties\"></a>\n\n| **Name** | **Type** | **Description** |\n| -------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ |\n| <code><a href=\"#@aws-amplify/database-construct.AmplifyDatabase.property.node\">node</a></code> | <code>constructs.Node</code> | The tree node. |\n| <code><a href=\"#@aws-amplify/database-construct.AmplifyDatabase.property.dataSourceStrategy\">dataSourceStrategy</a></code> | <code>@aws-amplify/graphql-api-construct.SQLLambdaModelDataSourceStrategy</code> | _No description._ |\n| <code><a href=\"#@aws-amplify/database-construct.AmplifyDatabase.property.resources\">resources</a></code> | <code><a href=\"#@aws-amplify/database-construct.AmplifyDatabaseResources\">AmplifyDatabaseResources</a></code> | Generated L1 and L2 CDK resources. |\n| <code><a href=\"#@aws-amplify/database-construct.AmplifyDatabase.property.stack\">stack</a></code> | <code>aws-cdk-lib.Stack</code> | Reference to parent stack of database construct. |\n\n---\n\n##### `node`<sup>Required</sup> <a name=\"node\" id=\"@aws-amplify/database-construct.AmplifyDatabase.property.node\"></a>\n\n```typescript\npublic readonly node: Node;\n```\n\n- _Type:_ constructs.Node\n\nThe tree node.\n\n---\n\n##### `dataSourceStrategy`<sup>Required</sup> <a name=\"dataSourceStrategy\" id=\"@aws-amplify/database-construct.AmplifyDatabase.property.dataSourceStrategy\"></a>\n\n```typescript\npublic readonly dataSourceStrategy: SQLLambdaModelDataSourceStrategy;\n```\n\n- _Type:_ @aws-amplify/graphql-api-construct.SQLLambdaModelDataSourceStrategy\n\n---\n\n##### `resources`<sup>Required</sup> <a name=\"resources\" id=\"@aws-amplify/database-construct.AmplifyDatabase.property.resources\"></a>\n\n```typescript\npublic readonly resources: AmplifyDatabaseResources;\n```\n\n- _Type:_ <a href=\"#@aws-amplify/database-construct.AmplifyDatabaseResources\">AmplifyDatabaseResources</a>\n\nGenerated L1 and L2 CDK resources.\n\n---\n\n##### `stack`<sup>Required</sup> <a name=\"stack\" id=\"@aws-amplify/database-construct.AmplifyDatabase.property.stack\"></a>\n\n```typescript\npublic readonly stack: Stack;\n```\n\n- _Type:_ aws-cdk-lib.Stack\n\nReference to parent stack of database construct.\n\n---\n\n## Structs <a name=\"Structs\" id=\"Structs\"></a>\n\n### AmplifyDatabaseProps <a name=\"AmplifyDatabaseProps\" id=\"@aws-amplify/database-construct.AmplifyDatabaseProps\"></a>\n\nInput props for the AmplifyDatabase construct.\n\n#### Initializer <a name=\"Initializer\" id=\"@aws-amplify/database-construct.AmplifyDatabaseProps.Initializer\"></a>\n\n```typescript\nimport { AmplifyDatabaseProps } from '@aws-amplify/database-construct'\n\nconst amplifyDatabaseProps: AmplifyDatabaseProps = { ... }\n```\n\n#### Properties <a name=\"Properties\" id=\"Properties\"></a>\n\n| **Name** | **Type** | **Description** |\n| ------------------------------------------------------------------------------------------------------- | ------------------------------------- | ----------------- |\n| <code><a href=\"#@aws-amplify/database-construct.AmplifyDatabaseProps.property.dbType\">dbType</a></code> | <code>string</code> | _No description._ |\n| <code><a href=\"#@aws-amplify/database-construct.AmplifyDatabaseProps.property.vpc\">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | _No description._ |\n\n---\n\n##### `dbType`<sup>Required</sup> <a name=\"dbType\" id=\"@aws-amplify/database-construct.AmplifyDatabaseProps.property.dbType\"></a>\n\n```typescript\npublic readonly dbType: string;\n```\n\n- _Type:_ string\n\n---\n\n##### `vpc`<sup>Required</sup> <a name=\"vpc\" id=\"@aws-amplify/database-construct.AmplifyDatabaseProps.property.vpc\"></a>\n\n```typescript\npublic readonly vpc: IVpc;\n```\n\n- _Type:_ aws-cdk-lib.aws_ec2.IVpc\n\n---\n\n### AmplifyDatabaseResources <a name=\"AmplifyDatabaseResources\" id=\"@aws-amplify/database-construct.AmplifyDatabaseResources\"></a>\n\n#### Initializer <a name=\"Initializer\" id=\"@aws-amplify/database-construct.AmplifyDatabaseResources.Initializer\"></a>\n\n```typescript\nimport { AmplifyDatabaseResources } from '@aws-amplify/database-construct'\n\nconst amplifyDatabaseResources: AmplifyDatabaseResources = { ... }\n```\n\n#### Properties <a name=\"Properties\" id=\"Properties\"></a>\n\n| **Name** | **Type** | **Description** |\n| ----------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | ---------------------------------------------- |\n| <code><a href=\"#@aws-amplify/database-construct.AmplifyDatabaseResources.property.consoleSecret\">consoleSecret</a></code> | <code>aws-cdk-lib.aws_secretsmanager.ISecret</code> | Username and password for the console user. |\n| <code><a href=\"#@aws-amplify/database-construct.AmplifyDatabaseResources.property.dataApiSecret\">dataApiSecret</a></code> | <code>aws-cdk-lib.aws_secretsmanager.ISecret</code> | Username and password for the data API user. |\n| <code><a href=\"#@aws-amplify/database-construct.AmplifyDatabaseResources.property.databaseCluster\">databaseCluster</a></code> | <code>aws-cdk-lib.aws_rds.IDatabaseCluster</code> | The database cluster created by the construct. |\n\n---\n\n##### `consoleSecret`<sup>Required</sup> <a name=\"consoleSecret\" id=\"@aws-amplify/database-construct.AmplifyDatabaseResources.property.consoleSecret\"></a>\n\n```typescript\npublic readonly consoleSecret: ISecret;\n```\n\n- _Type:_ aws-cdk-lib.aws_secretsmanager.ISecret\n\nUsername and password for the console user.\n\nThe Console user is used in the \"sandbox in the cloud\" for development on DB schema.\n\n---\n\n##### `dataApiSecret`<sup>Required</sup> <a name=\"dataApiSecret\" id=\"@aws-amplify/database-construct.AmplifyDatabaseResources.property.dataApiSecret\"></a>\n\n```typescript\npublic readonly dataApiSecret: ISecret;\n```\n\n- _Type:_ aws-cdk-lib.aws_secretsmanager.ISecret\n\nUsername and password for the data API user.\n\nThe Data API user is used to apply migrations and run SQL queries.\n\n---\n\n##### `databaseCluster`<sup>Required</sup> <a name=\"databaseCluster\" id=\"@aws-amplify/database-construct.AmplifyDatabaseResources.property.databaseCluster\"></a>\n\n```typescript\npublic readonly databaseCluster: IDatabaseCluster;\n```\n\n- _Type:_ aws-cdk-lib.aws_rds.IDatabaseCluster\n\nThe database cluster created by the construct.\n\n---\n"
},
"repository": {
"directory": "packages/database-construct",
Expand Down Expand Up @@ -4109,5 +4109,5 @@
}
},
"version": "0.0.1",
"fingerprint": "CaOq6QxEO+2yYgIUSmZqIaeAhN77zREj8WDcNuF7cGs="
"fingerprint": "kgTuppQnk23D1orY15m75klLJZtVWJcgjtwYEm9rmGY="
}
2 changes: 2 additions & 0 deletions packages/amplify-database-construct/src/__tests__/__snapshots__/types.test.ts.snap
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP

exports[` 1`] = `Object {}`;

exports[`types types are exported 1`] = `Object {}`;

0 comments on commit 1d2768e

Please sign in to comment.