@gemeentenijmegen/aws-constructs
Advanced tools
Comparing version 0.0.6 to 0.0.7
193
API.md
@@ -13,4 +13,197 @@ # AWS CDK Constructs for Gemeente Nijmegen | ||
| ## Constructs <a name="Constructs" id="Constructs"></a> | ||
| ### DeadLetterQueue <a name="DeadLetterQueue" id="@gemeentenijmegen/aws-constructs.DeadLetterQueue"></a> | ||
| #### Initializers <a name="Initializers" id="@gemeentenijmegen/aws-constructs.DeadLetterQueue.Initializer"></a> | ||
| ```typescript | ||
| import { DeadLetterQueue } from '@gemeentenijmegen/aws-constructs' | ||
| new DeadLetterQueue(scope: Construct, id: string, props: DeadLetterQueueProps) | ||
| ``` | ||
| | **Name** | **Type** | **Description** | | ||
| | --- | --- | --- | | ||
| | <code><a href="#@gemeentenijmegen/aws-constructs.DeadLetterQueue.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* | | ||
| | <code><a href="#@gemeentenijmegen/aws-constructs.DeadLetterQueue.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* | | ||
| | <code><a href="#@gemeentenijmegen/aws-constructs.DeadLetterQueue.Initializer.parameter.props">props</a></code> | <code><a href="#@gemeentenijmegen/aws-constructs.DeadLetterQueueProps">DeadLetterQueueProps</a></code> | *No description.* | | ||
| --- | ||
| ##### `scope`<sup>Required</sup> <a name="scope" id="@gemeentenijmegen/aws-constructs.DeadLetterQueue.Initializer.parameter.scope"></a> | ||
| - *Type:* constructs.Construct | ||
| --- | ||
| ##### `id`<sup>Required</sup> <a name="id" id="@gemeentenijmegen/aws-constructs.DeadLetterQueue.Initializer.parameter.id"></a> | ||
| - *Type:* string | ||
| --- | ||
| ##### `props`<sup>Required</sup> <a name="props" id="@gemeentenijmegen/aws-constructs.DeadLetterQueue.Initializer.parameter.props"></a> | ||
| - *Type:* <a href="#@gemeentenijmegen/aws-constructs.DeadLetterQueueProps">DeadLetterQueueProps</a> | ||
| --- | ||
| #### Methods <a name="Methods" id="Methods"></a> | ||
| | **Name** | **Description** | | ||
| | --- | --- | | ||
| | <code><a href="#@gemeentenijmegen/aws-constructs.DeadLetterQueue.toString">toString</a></code> | Returns a string representation of this construct. | | ||
| | <code><a href="#@gemeentenijmegen/aws-constructs.DeadLetterQueue.queue">queue</a></code> | *No description.* | | ||
| --- | ||
| ##### `toString` <a name="toString" id="@gemeentenijmegen/aws-constructs.DeadLetterQueue.toString"></a> | ||
| ```typescript | ||
| public toString(): string | ||
| ``` | ||
| Returns a string representation of this construct. | ||
| ##### `queue` <a name="queue" id="@gemeentenijmegen/aws-constructs.DeadLetterQueue.queue"></a> | ||
| ```typescript | ||
| public queue(): Queue | ||
| ``` | ||
| #### Static Functions <a name="Static Functions" id="Static Functions"></a> | ||
| | **Name** | **Description** | | ||
| | --- | --- | | ||
| | <code><a href="#@gemeentenijmegen/aws-constructs.DeadLetterQueue.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. | | ||
| --- | ||
| ##### ~~`isConstruct`~~ <a name="isConstruct" id="@gemeentenijmegen/aws-constructs.DeadLetterQueue.isConstruct"></a> | ||
| ```typescript | ||
| import { DeadLetterQueue } from '@gemeentenijmegen/aws-constructs' | ||
| DeadLetterQueue.isConstruct(x: any) | ||
| ``` | ||
| Checks if `x` is a construct. | ||
| ###### `x`<sup>Required</sup> <a name="x" id="@gemeentenijmegen/aws-constructs.DeadLetterQueue.isConstruct.parameter.x"></a> | ||
| - *Type:* any | ||
| Any object. | ||
| --- | ||
| #### Properties <a name="Properties" id="Properties"></a> | ||
| | **Name** | **Type** | **Description** | | ||
| | --- | --- | --- | | ||
| | <code><a href="#@gemeentenijmegen/aws-constructs.DeadLetterQueue.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. | | ||
| --- | ||
| ##### `node`<sup>Required</sup> <a name="node" id="@gemeentenijmegen/aws-constructs.DeadLetterQueue.property.node"></a> | ||
| ```typescript | ||
| public readonly node: Node; | ||
| ``` | ||
| - *Type:* constructs.Node | ||
| The tree node. | ||
| --- | ||
| ## Structs <a name="Structs" id="Structs"></a> | ||
| ### DeadLetterQueueProps <a name="DeadLetterQueueProps" id="@gemeentenijmegen/aws-constructs.DeadLetterQueueProps"></a> | ||
| #### Initializer <a name="Initializer" id="@gemeentenijmegen/aws-constructs.DeadLetterQueueProps.Initializer"></a> | ||
| ```typescript | ||
| import { DeadLetterQueueProps } from '@gemeentenijmegen/aws-constructs' | ||
| const deadLetterQueueProps: DeadLetterQueueProps = { ... } | ||
| ``` | ||
| #### Properties <a name="Properties" id="Properties"></a> | ||
| | **Name** | **Type** | **Description** | | ||
| | --- | --- | --- | | ||
| | <code><a href="#@gemeentenijmegen/aws-constructs.DeadLetterQueueProps.property.kmsKey">kmsKey</a></code> | <code>aws-cdk-lib.aws_kms.Key</code> | Key to encrypt the queue. | | ||
| | <code><a href="#@gemeentenijmegen/aws-constructs.DeadLetterQueueProps.property.alarm">alarm</a></code> | <code>boolean</code> | Setup alarm. | | ||
| | <code><a href="#@gemeentenijmegen/aws-constructs.DeadLetterQueueProps.property.alarmDescription">alarmDescription</a></code> | <code>string</code> | Alarm Description. | | ||
| | <code><a href="#@gemeentenijmegen/aws-constructs.DeadLetterQueueProps.property.dlq">dlq</a></code> | <code>aws-cdk-lib.aws_sqs.Queue</code> | Bring your own dead letter queue. | | ||
| | <code><a href="#@gemeentenijmegen/aws-constructs.DeadLetterQueueProps.property.retentionPeriod">retentionPeriod</a></code> | <code>aws-cdk-lib.Duration</code> | Retention period. | | ||
| --- | ||
| ##### `kmsKey`<sup>Required</sup> <a name="kmsKey" id="@gemeentenijmegen/aws-constructs.DeadLetterQueueProps.property.kmsKey"></a> | ||
| ```typescript | ||
| public readonly kmsKey: Key; | ||
| ``` | ||
| - *Type:* aws-cdk-lib.aws_kms.Key | ||
| Key to encrypt the queue. | ||
| --- | ||
| ##### `alarm`<sup>Optional</sup> <a name="alarm" id="@gemeentenijmegen/aws-constructs.DeadLetterQueueProps.property.alarm"></a> | ||
| ```typescript | ||
| public readonly alarm: boolean; | ||
| ``` | ||
| - *Type:* boolean | ||
| - *Default:* true | ||
| Setup alarm. | ||
| --- | ||
| ##### `alarmDescription`<sup>Optional</sup> <a name="alarmDescription" id="@gemeentenijmegen/aws-constructs.DeadLetterQueueProps.property.alarmDescription"></a> | ||
| ```typescript | ||
| public readonly alarmDescription: string; | ||
| ``` | ||
| - *Type:* string | ||
| - *Default:* | ||
| Alarm Description. | ||
| --- | ||
| ##### `dlq`<sup>Optional</sup> <a name="dlq" id="@gemeentenijmegen/aws-constructs.DeadLetterQueueProps.property.dlq"></a> | ||
| ```typescript | ||
| public readonly dlq: Queue; | ||
| ``` | ||
| - *Type:* aws-cdk-lib.aws_sqs.Queue | ||
| Bring your own dead letter queue. | ||
| --- | ||
| ##### `retentionPeriod`<sup>Optional</sup> <a name="retentionPeriod" id="@gemeentenijmegen/aws-constructs.DeadLetterQueueProps.property.retentionPeriod"></a> | ||
| ```typescript | ||
| public readonly retentionPeriod: Duration; | ||
| ``` | ||
| - *Type:* aws-cdk-lib.Duration | ||
| - *Default:* 14 days | ||
| Retention period. | ||
| --- | ||
| ## Classes <a name="Classes" id="Classes"></a> | ||
@@ -17,0 +210,0 @@ |
| export * from './PermissionsBoundaryAspect'; | ||
| export * from './DeadLetterQueue'; |
@@ -14,2 +14,3 @@ "use strict"; | ||
| __exportStar(require("./PermissionsBoundaryAspect"), exports); | ||
| //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7O0FBQUEsOERBQTRDIiwic291cmNlc0NvbnRlbnQiOlsiZXhwb3J0ICogZnJvbSAnLi9QZXJtaXNzaW9uc0JvdW5kYXJ5QXNwZWN0JzsiXX0= | ||
| __exportStar(require("./DeadLetterQueue"), exports); | ||
| //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7O0FBQUEsOERBQTRDO0FBQzVDLG9EQUFrQyIsInNvdXJjZXNDb250ZW50IjpbImV4cG9ydCAqIGZyb20gJy4vUGVybWlzc2lvbnNCb3VuZGFyeUFzcGVjdCc7XG5leHBvcnQgKiBmcm9tICcuL0RlYWRMZXR0ZXJRdWV1ZSc7Il19 |
@@ -43,3 +43,3 @@ "use strict"; | ||
| _a = JSII_RTTI_SYMBOL_1; | ||
| PermissionsBoundaryAspect[_a] = { fqn: "@gemeentenijmegen/aws-constructs.PermissionsBoundaryAspect", version: "0.0.6" }; | ||
| PermissionsBoundaryAspect[_a] = { fqn: "@gemeentenijmegen/aws-constructs.PermissionsBoundaryAspect", version: "0.0.7" }; | ||
| //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUGVybWlzc2lvbnNCb3VuZGFyeUFzcGVjdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9QZXJtaXNzaW9uc0JvdW5kYXJ5QXNwZWN0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7O0FBQUEsNkNBQTBEO0FBRzFEOzs7Ozs7R0FNRztBQUNILE1BQWEseUJBQXlCO0lBV3BDOzs7O09BSUc7SUFDSCxZQUFtQixRQUFpQixFQUFFLHNCQUErQjtRQUNuRSxJQUFJLENBQUMsUUFBUSxHQUFHLFFBQVEsSUFBSSxHQUFHLENBQUM7UUFDaEMsSUFBSSxDQUFDLHNCQUFzQixHQUFHLHNCQUFzQixJQUFJLDJDQUEyQyxDQUFDO0lBQ3RHLENBQUM7SUFFTSxLQUFLLENBQUMsSUFBZ0I7UUFFM0IsSUFBSSxJQUFJLFlBQVkseUJBQVcsSUFBSSxJQUFJLENBQUMsZUFBZSxJQUFJLGdCQUFnQixFQUFFO1lBQzNFLE1BQU0sS0FBSyxHQUFHLG1CQUFLLENBQUMsRUFBRSxDQUFDLElBQUksQ0FBQyxDQUFDO1lBQzdCLElBQUksQ0FBQyxxQkFBcUIsQ0FBQyxJQUFJLEVBQUUsS0FBSyxDQUFDLENBQUM7U0FDekM7SUFDSCxDQUFDO0lBRUQscUJBQXFCLENBQUMsV0FBd0IsRUFBRSxLQUFZO1FBQzFELGlDQUFpQztRQUNqQyxJQUFJLElBQUksQ0FBQyxRQUFRLEVBQUU7WUFDakIsV0FBVyxDQUFDLG1CQUFtQixDQUFDLE1BQU0sRUFBRSxJQUFJLENBQUMsUUFBUSxDQUFDLENBQUM7U0FDeEQ7UUFDRCxnREFBZ0Q7UUFDaEQsSUFBSSxJQUFJLENBQUMsc0JBQXNCLElBQUksQ0FBQyxJQUFJLENBQUMsc0JBQXNCLENBQUMsVUFBVSxDQUFDLGFBQWEsQ0FBQyxFQUFFO1lBQ3pGLFdBQVcsQ0FBQyxtQkFBbUIsQ0FBQyxxQkFBcUIsRUFBRSxnQkFBZ0IsS0FBSyxDQUFDLE9BQU8sV0FBVyxJQUFJLENBQUMsc0JBQXNCLEVBQUUsQ0FBQyxDQUFDO1NBQy9IO0lBQ0gsQ0FBQzs7QUF0Q0gsOERBdUNDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgQ2ZuUmVzb3VyY2UsIElBc3BlY3QsIFN0YWNrIH0gZnJvbSAnYXdzLWNkay1saWInO1xuaW1wb3J0IHsgSUNvbnN0cnVjdCB9IGZyb20gJ2NvbnN0cnVjdHMnO1xuXG4vKipcbiAqIEFzIGEgYmVzdCBwcmFjdGljZSBvcmdhbml6YXRpb25zIGVuZm9yY2UgcG9saWNpZXMgd2hpY2ggcmVxdWlyZSBhbGwgY3VzdG9tIElBTSBSb2xlcyBjcmVhdGVkIHRvIGJlIGRlZmluZWQgdW5kZXJcbiAqIGEgc3BlY2lmaWMgcGF0aCBhbmQgcGVybWlzc2lvbiBib3VuZGFyeS4gV2VsbCwgdGhpcyBhbGxvd3MgYmV0dGVyIGdvdmVybmFuY2UgYW5kIGFsc28gcHJldmVudHMgdW5pbnRlbmRlZCBwcml2aWxlZ2UgZXNjYWxhdGlvbi5cbiAqIEFXUyBDREsgaGlnaCBsZXZlbCBjb25zdHJ1Y3RzIGFuZCBwYXR0ZXJucyBlbmNhcHN1bGF0ZXMgdGhlIHJvbGUgY3JlYXRpb24gZnJvbSBlbmQgdXNlcnMuXG4gKiBTbyBpdCBpcyBhIGxhYm9yaW91cyBhbmQgYXQgdGltZXMgaW1wb3NzaWJsZSB0byBnZXQgYSBoYW5kbGUgb2YgbmV3bHkgY3JlYXRlZCByb2xlcyB3aXRoaW4gYSBzdGFjay5cbiAqIFRoaXMgYXNwZWN0IHdpbGwgc2NhbiBhbGwgcm9sZXMgd2l0aGluIHRoZSBnaXZlbiBzY29wZSBhbmQgd2lsbCBhdHRhY2ggdGhlIHJpZ2h0IHBlcm1pc3Npb24gYm91bmRhcnkgYW5kIHBhdGggdG8gdGhlbS5cbiAqL1xuZXhwb3J0IGNsYXNzIFBlcm1pc3Npb25zQm91bmRhcnlBc3BlY3QgaW1wbGVtZW50cyBJQXNwZWN0IHtcbiAgLyoqXG4gICAqIFRoZSByb2xlIHBhdGggdG8gYXR0YWNoIHRvIG5ld2x5IGNyZWF0ZWQgcm9sZXMuXG4gICAqL1xuICByb2xlUGF0aD86IHN0cmluZztcblxuICAvKipcbiAgICogVGhlIHBlcm1pc3Npb24gYm91bmRhcnkgdG8gYXR0YWNoIHRvIG5ld2x5IGNyZWF0ZWQgcm9sZXMuXG4gICAqL1xuICByb2xlUGVybWlzc2lvbkJvdW5kYXJ5OiBzdHJpbmc7XG5cbiAgLyoqXG4gICAqIENvbnN0cnVjdHMgYSBuZXcgUGVybWlzc2lvbnNCb3VuZGFyeUFzcGVjdC5cbiAgICogQHBhcmFtIHJvbGVQYXRoIC0gdGhlIHJvbGUgcGF0aCB0byBhdHRhY2ggdG8gbmV3bHkgY3JlYXRlZCByb2xlcy5cbiAgICogQHBhcmFtIHJvbGVQZXJtaXNzaW9uQm91bmRhcnkgLSB0aGUgcGVybWlzc2lvbiBib3VuZGFyeSB0byBhdHRhY2ggdG8gbmV3bHkgY3JlYXRlZCByb2xlcy5cbiAgICovXG4gIHB1YmxpYyBjb25zdHJ1Y3Rvcihyb2xlUGF0aD86IHN0cmluZywgcm9sZVBlcm1pc3Npb25Cb3VuZGFyeT86IHN0cmluZykge1xuICAgIHRoaXMucm9sZVBhdGggPSByb2xlUGF0aCA/PyAnLyc7XG4gICAgdGhpcy5yb2xlUGVybWlzc2lvbkJvdW5kYXJ5ID0gcm9sZVBlcm1pc3Npb25Cb3VuZGFyeSA/PyAnbGFuZGluZ3pvbmUtd29ya2xvYWQtcGVybWlzc2lvbnMtYm91bmRhcnknO1xuICB9XG5cbiAgcHVibGljIHZpc2l0KG5vZGU6IElDb25zdHJ1Y3QpOiB2b2lkIHtcblxuICAgIGlmIChub2RlIGluc3RhbmNlb2YgQ2ZuUmVzb3VyY2UgJiYgbm9kZS5jZm5SZXNvdXJjZVR5cGUgPT0gJ0FXUzo6SUFNOjpSb2xlJykge1xuICAgICAgY29uc3Qgc3RhY2sgPSBTdGFjay5vZihub2RlKTtcbiAgICAgIHRoaXMuYWRkUGVybWlzc2lvbkJvdW5kYXJ5KG5vZGUsIHN0YWNrKTtcbiAgICB9XG4gIH1cblxuICBhZGRQZXJtaXNzaW9uQm91bmRhcnkoY2ZuUmVzb3VyY2U6IENmblJlc291cmNlLCBzdGFjazogU3RhY2spIHtcbiAgICAvLyBzZXQgdGhlIHBhdGggaWYgaXQgaXMgcHJvdmlkZWRcbiAgICBpZiAodGhpcy5yb2xlUGF0aCkge1xuICAgICAgY2ZuUmVzb3VyY2UuYWRkUHJvcGVydHlPdmVycmlkZSgnUGF0aCcsIHRoaXMucm9sZVBhdGgpO1xuICAgIH1cbiAgICAvLyBzZXQgdGhlIHBlcm1pc3Npb24gYm91bmRhcnkgaWYgaXQgaXMgcHJvdmlkZWRcbiAgICBpZiAodGhpcy5yb2xlUGVybWlzc2lvbkJvdW5kYXJ5ICYmICF0aGlzLnJvbGVQZXJtaXNzaW9uQm91bmRhcnkuc3RhcnRzV2l0aCgnYXJuOmF3czppYW0nKSkge1xuICAgICAgY2ZuUmVzb3VyY2UuYWRkUHJvcGVydHlPdmVycmlkZSgnUGVybWlzc2lvbnNCb3VuZGFyeScsIGBhcm46YXdzOmlhbTo6JHtzdGFjay5hY2NvdW50fTpwb2xpY3kvJHt0aGlzLnJvbGVQZXJtaXNzaW9uQm91bmRhcnl9YCk7XG4gICAgfVxuICB9XG59XG5cbiJdfQ== |
@@ -37,3 +37,3 @@ { | ||
| "devDependencies": { | ||
| "@gemeentenijmegen/projen-project-type": "^1.5.6", | ||
| "@gemeentenijmegen/projen-project-type": "^1.5.8", | ||
| "@types/jest": "^27", | ||
@@ -51,5 +51,5 @@ "@types/node": "^16 <= 16.18.78", | ||
| "jsii": "1.x", | ||
| "jsii-diff": "^1.96.0", | ||
| "jsii-diff": "^1.97.0", | ||
| "jsii-docgen": "^7.2.9", | ||
| "jsii-pacmak": "^1.96.0", | ||
| "jsii-pacmak": "^1.97.0", | ||
| "jsii-rosetta": "1.x", | ||
@@ -77,3 +77,3 @@ "projen": "^0.79.27", | ||
| }, | ||
| "version": "0.0.6", | ||
| "version": "0.0.7", | ||
| "jest": { | ||
@@ -80,0 +80,0 @@ "testMatch": [ |
Sorry, the diff of this file is not supported yet
No alert changes
Improved metrics
- Total package byte prevSize
- increased by13.59%
139791
- Number of package files
- increased by22.22%
11
- Lines of code
- increased by92.86%
162
No dependency changes