@aws-solutions-constructs/aws-fargate-kinesisstreams 2.85.2 → 2.85.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/.jsii CHANGED
@@ -8,7 +8,7 @@
8
8
  "url": "https://aws.amazon.com"
9
9
  },
10
10
  "dependencies": {
11
- "@aws-solutions-constructs/core": "2.85.2",
11
+ "@aws-solutions-constructs/core": "2.85.4",
12
12
  "aws-cdk-lib": "^2.193.0",
13
13
  "constructs": "^10.0.0"
14
14
  },
@@ -3993,7 +3993,7 @@
3993
3993
  },
3994
3994
  "name": "@aws-solutions-constructs/aws-fargate-kinesisstreams",
3995
3995
  "readme": {
3996
- "markdown": "# aws-fargate-kinesisstreams module\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge)\n\n---\n<!--END STABILITY BANNER-->\n\n| **Reference Documentation**:| <span style=\"font-weight: normal\">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|\n|:-------------|:-------------|\n<div style=\"height:8px\"></div>\n\n| **Language** | **Package** |\n|:-------------|-----------------|\n|![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python|`aws_solutions_constructs.aws_fargate_kinesisstreams`|\n|![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-fargate-kinesisstreams`|\n|![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.fargatekinesisstreams`|\n\n## Overview\nThis AWS Solutions Construct deploys an AWS Fargate Service that can put records on an Amazon Kinesis Data Stream.\n\nHere is a minimal deployable pattern definition:\n\nTypescript\n``` typescript\nimport { Construct } from 'constructs';\nimport { Stack, StackProps } from 'aws-cdk-lib';\nimport { FargateToKinesisStreamsProps } from '@aws-solutions-constructs/aws-fargate-kinesisstreams';\nimport * as fargate from 'aws-cdk-lib/aws-fargate';\n\nnew FargateToKinesisStreams(this, 'FargateToKinesisStreams', {\n publicApi: true,\n ecrRepositoryArn: \"arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo\",\n});\n```\n\nPython\n``` python\nfrom aws_solutions_constructs.aws_fargate_kinesisstreams import FargateToKinesisStreams\nfrom aws_cdk import (\n aws_fargate as _fargate,\n Stack\n)\nfrom constructs import Construct\n\nFargateToKinesisStreams(self, 'FargateToKinesisStreams',\n public_api=True,\n ecr_repository_arn=\"arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo\"\n )\n```\n\nJava\n``` java\nimport software.constructs.Construct;\n\nimport software.amazon.awscdk.Stack;\nimport software.amazon.awscdk.StackProps;\nimport software.amazon.awscdk.services.fargate.*;\nimport software.amazon.awscdk.services.fargate.eventsources.*;\nimport software.amazon.awscdk.services.fargate.Runtime;\nimport software.amazon.awsconstructs.services.fargatekinesisstreams.*;\n\nnew FargateToKinesisStreams(this, \"FargateToKinesisStreams\", new FargateToKinesisStreamsProps.Builder()\n .publicApi(true)\n .ecrRepositoryArn(\"arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo\")\n .build());\n```\n\n## Pattern Construct Props\n\n| **Name** | **Type** | **Description** |\n|:-------------|:----------------|-----------------|\n| publicApi | `boolean` | True if the VPC provisioned by this construct should contain Public/Private Subnets, otherwise False for the VPC to contain Isolated Subnets only. Note this property is ignored if an existing VPC is specified in the `existingVpc` property. |\n| vpcProps? | [`ec2.VpcProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.VpcProps.html) | Optional custom properties for a new VPC the construct will create. Providing both this and `existingVpc` is an error. An Amazon Kinesis Streams Interface Endpoint will be added to this VPC. |\n| existingVpc? | [`ec2.IVpc`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html) | An existing VPC in which to deploy the Fargate Service. Providing both this and `vpcProps` is an error. If the client provides an existing Fargate Service in the `existingFargateServiceObject` property, this value must be the VPC where the service is running. An Amazon Kinesis Streams Interface Endpoint will be added to this VPC. |\n| clusterProps? | [`ecs.ClusterProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ClusterProps.html) | Optional properties to create a new ECS cluster. To provide an existing cluster, use the cluster attribute of fargateServiceProps. |\n| ecrRepositoryArn? | `string` | The arn of an ECR Repository containing the image to use to generate the containers. Either this or the image property of containerDefinitionProps must be provided. format: arn:aws:ecr:*region*:*account number*:repository/*Repository Name* |\n| ecrImageVersion? | `string` | The version of the image to use from the repository. Defaults to 'Latest' |\n| containerDefinitionProps? | [`ecs.ContainerDefinitionProps \\| any`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ContainerDefinitionProps.html) | Optional props to define the container created for the Fargate Service. (defaults found in fargate-defaults.ts) |\n| fargateTaskDefinitionProps? | [`ecs.FargateTaskDefinitionProps \\| any`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateTaskDefinitionProps.html) | Optional props to define the Fargate Task Definition for this construct. (defaults found in fargate-defaults.ts) |\n| fargateServiceProps? | [`ecs.FargateServiceProps \\| any`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateServiceProps.html) | Optional values to override default Fargate Task definition properties (fargate-defaults.ts). The construct will default to launching the service is the most isolated subnets available (precedence: Isolated, Private and Public). Override those and other defaults here. |\n| existingFargateServiceObject? | [`ecs.FargateService`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateService.html) | A Fargate Service already instantiated (probably by another Solutions Construct). If this is specified, then no props defining a new service can be provided, including: ecrImageVersion, containerDefinitionProps, fargateTaskDefinitionProps, ecrRepositoryArn, fargateServiceProps, clusterProps |\n| existingContainerDefinitionObject? | [`ecs.ContainerDefinition`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ContainerDefinition.html) | A container definition already instantiated as part of a Fargate service. This must be the container in the `existingFargateServiceObject`. |\n|existingStreamObj?|[`kinesis.Stream`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kinesis.Stream.html) | Existing instance of a Kinesis Data Stream. Providing both this and `kinesisStreamProps` will cause an error. |\n|kinesisStreamProps?|[`kinesis.StreamProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kinesis.StreamProps.html) | Optional user-provided props to override the default props for the Kinesis Data Stream. Providing both this and `existingStreamObj` will cause an error. |\n| createCloudWatchAlarms |`boolean` | Whether to create recommended CloudWatch Alarms for the Kinesis Stream (defaults to true). |\n| streamEnvironmentVariableName? | `string` | Optional Name to override the Fargate Service default environment variable name that holds the Kinesis Data Stream name value. Default: KINESIS_DATASTREAM_NAME |\n\n## Pattern Properties\n\n| **Name** | **Type** | **Description** |\n|:-------------|:----------------|-----------------|\n| vpc | [`ec2.IVpc`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html) | The new or existing VPC used by the construct. |\n| service | [`ecs.FargateService`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateService.html) | The new or existing AWS Fargate service used by this construct. |\n| container | [`ecs.ContainerDefinition`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ContainerDefinition.html) | The container associated with the AWS Fargate service in the service property. |\n| kinesisStream | [`kinesis.Stream`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kinesis.Stream.html) | The new or existing Kinesis Data Stream used by this construct. |\n| cloudwatchAlarms? | [`cloudwatch.Alarm[]`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch.Alarm.html) | Returns the CloudWatch Alarms created to monitor the Kinesis Data Stream.|\n\n## Default settings\n\nOut of the box implementation of the Construct without any overrides will set the following defaults:\n\n### AWS Fargate Service\n* An AWS Fargate Service running in the isolated subnets of a new VPC\n* Minimally-permissive IAM role for the Fargate Service to put records on the Kinesis Data Stream\n* Sets an Environment Variable named KINESIS_DATASTREAM_NAME that holds the Kinesis Data Stream Name, which is a required property of the Kinesis Data Streams SDK when making calls to it\n\n### Amazon Kinesis Stream\n* Enable server-side encryption for the Kinesis Data Stream using an AWS Managed CMK\n* Deploy best practices CloudWatch Alarms for the Kinesis Data Stream\n* An Interface Endpoint on the VPC for private communication between the Fargate Service and the Kinesis Data Stream\n\n## Architecture\n![Architecture Diagram](architecture.png)\n\n***\n&copy; Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved."
3996
+ "markdown": "Documentation for this pattern can be found [here](https://github.com/awslabs/aws-solutions-constructs/blob/main/source/patterns/%40aws-solutions-constructs/aws-fargate-kinesisstreams/README.adoc)\n"
3997
3997
  },
3998
3998
  "repository": {
3999
3999
  "directory": "source/patterns/@aws-solutions-constructs/aws-fargate-kinesisstreams",
@@ -4410,6 +4410,6 @@
4410
4410
  "symbolId": "lib/index:FargateToKinesisStreamsProps"
4411
4411
  }
4412
4412
  },
4413
- "version": "2.85.2",
4414
- "fingerprint": "K1e9w9BC3700/i22V995ZJuR3KbyFFNNAAdNshtfgYo="
4413
+ "version": "2.85.4",
4414
+ "fingerprint": "eCZXNNBQhaOXw17/Vn+1mPgw7iEpJXjivNx0c1u0//c="
4415
4415
  }
package/README.adoc ADDED
@@ -0,0 +1,240 @@
1
+ //!!NODE_ROOT <section>
2
+ //== aws-fargate-kinesisstreams module
3
+
4
+ [.topic]
5
+ = aws-fargate-kinesisstreams
6
+ :info_doctype: section
7
+ :info_title: aws-fargate-kinesisstreams
8
+
9
+
10
+ image:https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge[Stability:Experimental]
11
+
12
+ [width="100%",cols="<50%,<50%",options="header",]
13
+ |===
14
+ |*Reference Documentation*:
15
+ |https://docs.aws.amazon.com/solutions/latest/constructs/
16
+ |===
17
+
18
+ [width="100%",cols="<46%,54%",options="header",]
19
+ |===
20
+ |*Language* |*Package*
21
+ |image:https://docs.aws.amazon.com/cdk/api/latest/img/python32.png[Python
22
+ Logo] Python
23
+ |`aws_solutions_constructs.aws_fargate_kinesisstreams`
24
+
25
+ |image:https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png[Typescript
26
+ Logo] Typescript |`@aws-solutions-constructs/aws-fargate-kinesisstreams`
27
+
28
+ |image:https://docs.aws.amazon.com/cdk/api/latest/img/java32.png[Java
29
+ Logo] Java
30
+ |`software.amazon.awsconstructs.services.fargatekinesisstreams`
31
+ |===
32
+
33
+ == Overview
34
+
35
+ This AWS Solutions Construct deploys an AWS Fargate Service that can put
36
+ records on an Amazon Kinesis Data Stream.
37
+
38
+ Here is a minimal deployable pattern definition:
39
+
40
+ ====
41
+ [role="tablist"]
42
+ Typescript::
43
+ +
44
+ [source,typescript]
45
+ ----
46
+ import { Construct } from 'constructs';
47
+ import { Stack, StackProps } from 'aws-cdk-lib';
48
+ import { FargateToKinesisStreamsProps } from '@aws-solutions-constructs/aws-fargate-kinesisstreams';
49
+ import * as fargate from 'aws-cdk-lib/aws-fargate';
50
+
51
+ new FargateToKinesisStreams(this, 'FargateToKinesisStreams', {
52
+ publicApi: true,
53
+ ecrRepositoryArn: "arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo",
54
+ });
55
+ ----
56
+
57
+ Python::
58
+ +
59
+ [source,python]
60
+ ----
61
+ from aws_solutions_constructs.aws_fargate_kinesisstreams import FargateToKinesisStreams
62
+ from aws_cdk import (
63
+ aws_fargate as _fargate,
64
+ Stack
65
+ )
66
+ from constructs import Construct
67
+
68
+ FargateToKinesisStreams(self, 'FargateToKinesisStreams',
69
+ public_api=True,
70
+ ecr_repository_arn="arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo"
71
+ )
72
+ ----
73
+
74
+ Java::
75
+ +
76
+ [source,java]
77
+ ----
78
+ import software.constructs.Construct;
79
+
80
+ import software.amazon.awscdk.Stack;
81
+ import software.amazon.awscdk.StackProps;
82
+ import software.amazon.awscdk.services.fargate.*;
83
+ import software.amazon.awscdk.services.fargate.eventsources.*;
84
+ import software.amazon.awscdk.services.fargate.Runtime;
85
+ import software.amazon.awsconstructs.services.fargatekinesisstreams.*;
86
+
87
+ new FargateToKinesisStreams(this, "FargateToKinesisStreams", new FargateToKinesisStreamsProps.Builder()
88
+ .publicApi(true)
89
+ .ecrRepositoryArn("arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo")
90
+ .build());
91
+ ----
92
+ ====
93
+
94
+ == Pattern Construct Props
95
+
96
+ [width="100%",cols="<30%,<35%,35%",options="header",]
97
+ |===
98
+ |*Name* |*Type* |*Description*
99
+ |publicApi |`boolean` |True if the VPC provisioned by this construct
100
+ should contain Public/Private Subnets, otherwise False for the VPC to
101
+ contain Isolated Subnets only. Note this property is ignored if an
102
+ existing VPC is specified in the `existingVpc` property.
103
+
104
+ |vpcProps?
105
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.VpcProps.html[`ec2.VpcProps`]
106
+ |Optional custom properties for a new VPC the construct will create.
107
+ Providing both this and `existingVpc` is an error. An Amazon Kinesis
108
+ Streams Interface Endpoint will be added to this VPC.
109
+
110
+ |existingVpc?
111
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html[`ec2.IVpc`]
112
+ |An existing VPC in which to deploy the Fargate Service. Providing both
113
+ this and `vpcProps` is an error. If the client provides an existing
114
+ Fargate Service in the `existingFargateServiceObject` property, this
115
+ value must be the VPC where the service is running. An Amazon Kinesis
116
+ Streams Interface Endpoint will be added to this VPC.
117
+
118
+ |clusterProps?
119
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ClusterProps.html[`ecs.ClusterProps`]
120
+ |Optional properties to create a new ECS cluster. To provide an existing
121
+ cluster, use the cluster attribute of fargateServiceProps.
122
+
123
+ |ecrRepositoryArn? |`string` |The arn of an ECR Repository containing
124
+ the image to use to generate the containers. Either this or the image
125
+ property of containerDefinitionProps must be provided. format:
126
+ arn:aws:ecr:_region_:_account number_:repository/_Repository Name_
127
+
128
+ |ecrImageVersion? |`string` |The version of the image to use from the
129
+ repository. Defaults to '`Latest`'
130
+
131
+ |containerDefinitionProps?
132
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ContainerDefinitionProps.html[`ecs.ContainerDefinitionProps`] {vbar} any
133
+ |Optional props to define the container created for the Fargate Service.
134
+ (defaults found in fargate-defaults.ts)
135
+
136
+ |fargateTaskDefinitionProps?
137
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateTaskDefinitionProps.html[`ecs.FargateTaskDefinitionProps`] {vbar} any
138
+ |Optional props to define the Fargate Task Definition for this
139
+ construct. (defaults found in fargate-defaults.ts)
140
+
141
+ |fargateServiceProps?
142
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateServiceProps.html[`ecs.FargateServiceProps`] {vbar} any
143
+ |Optional values to override default Fargate Task definition properties
144
+ (fargate-defaults.ts). The construct will default to launching the
145
+ service is the most isolated subnets available (precedence: Isolated,
146
+ Private and Public). Override those and other defaults here.
147
+
148
+ |existingFargateServiceObject?
149
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateService.html[`ecs.FargateService`]
150
+ |A Fargate Service already instantiated (probably by another Solutions
151
+ Construct). If this is specified, then no props defining a new service
152
+ can be provided, including: ecrImageVersion, containerDefinitionProps,
153
+ fargateTaskDefinitionProps, ecrRepositoryArn, fargateServiceProps,
154
+ clusterProps
155
+
156
+ |existingContainerDefinitionObject?
157
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ContainerDefinition.html[`ecs.ContainerDefinition`]
158
+ |A container definition already instantiated as part of a Fargate
159
+ service. This must be the container in the
160
+ `existingFargateServiceObject`.
161
+
162
+ |existingStreamObj?
163
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kinesis.Stream.html[`kinesis.Stream`]
164
+ |Existing instance of a Kinesis Data Stream. Providing both this and
165
+ `kinesisStreamProps` will cause an error.
166
+
167
+ |kinesisStreamProps?
168
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kinesis.StreamProps.html[`kinesis.StreamProps`]
169
+ |Optional user-provided props to override the default props for the
170
+ Kinesis Data Stream. Providing both this and `existingStreamObj` will
171
+ cause an error.
172
+
173
+ |createCloudWatchAlarms |`boolean` |Whether to create recommended
174
+ CloudWatch Alarms for the Kinesis Stream (defaults to true).
175
+
176
+ |streamEnvironmentVariableName? |`string` |Optional Name to override the
177
+ Fargate Service default environment variable name that holds the Kinesis
178
+ Data Stream name value. Default: KINESIS_DATASTREAM_NAME
179
+ |===
180
+
181
+ == Pattern Properties
182
+
183
+ [width="100%",cols="<30%,<35%,35%",options="header",]
184
+ |===
185
+ |*Name* |*Type* |*Description*
186
+ |vpc
187
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html[`ec2.IVpc`]
188
+ |The new or existing VPC used by the construct.
189
+
190
+ |service
191
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateService.html[`ecs.FargateService`]
192
+ |The new or existing AWS Fargate service used by this construct.
193
+
194
+ |container
195
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ContainerDefinition.html[`ecs.ContainerDefinition`]
196
+ |The container associated with the AWS Fargate service in the service
197
+ property.
198
+
199
+ |kinesisStream
200
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kinesis.Stream.html[`kinesis.Stream`]
201
+ |The new or existing Kinesis Data Stream used by this construct.
202
+
203
+ |cloudwatchAlarms?
204
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch.Alarm.html[`cloudwatch.Alarm[\]`]
205
+ |Returns the CloudWatch Alarms created to monitor the Kinesis Data
206
+ Stream.
207
+ |===
208
+
209
+ == Default settings
210
+
211
+ Out of the box implementation of the Construct without any overrides
212
+ will set the following defaults:
213
+
214
+ === AWS Fargate Service
215
+
216
+ * An AWS Fargate Service running in the isolated subnets of a new VPC
217
+ * Minimally-permissive IAM role for the Fargate Service to put records
218
+ on the Kinesis Data Stream
219
+ * Sets an Environment Variable named KINESIS_DATASTREAM_NAME
220
+ that holds the Kinesis Data Stream Name, which is a required property of
221
+ the Kinesis Data Streams SDK when making calls to it
222
+
223
+ === Amazon Kinesis Stream
224
+
225
+ * Enable server-side encryption for the Kinesis Data Stream using an AWS
226
+ Managed CMK
227
+ * Deploy best practices CloudWatch Alarms for the Kinesis Data Stream
228
+ * An Interface Endpoint on the VPC for private communication between the
229
+ Fargate Service and the Kinesis Data Stream
230
+
231
+ == Architecture
232
+
233
+
234
+ image::aws-fargate-kinesisstreams.png["Diagram showing the Fargate service, Kinesis data stream and CloudWatch alarms created by the construct",scaledwidth=100%]
235
+
236
+ // github block
237
+
238
+ '''''
239
+
240
+ © Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
package/README.md CHANGED
@@ -1,119 +1 @@
1
- # aws-fargate-kinesisstreams module
2
- <!--BEGIN STABILITY BANNER-->
3
-
4
- ---
5
-
6
- ![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge)
7
-
8
- ---
9
- <!--END STABILITY BANNER-->
10
-
11
- | **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|
12
- |:-------------|:-------------|
13
- <div style="height:8px"></div>
14
-
15
- | **Language** | **Package** |
16
- |:-------------|-----------------|
17
- |![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python|`aws_solutions_constructs.aws_fargate_kinesisstreams`|
18
- |![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-fargate-kinesisstreams`|
19
- |![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.fargatekinesisstreams`|
20
-
21
- ## Overview
22
- This AWS Solutions Construct deploys an AWS Fargate Service that can put records on an Amazon Kinesis Data Stream.
23
-
24
- Here is a minimal deployable pattern definition:
25
-
26
- Typescript
27
- ``` typescript
28
- import { Construct } from 'constructs';
29
- import { Stack, StackProps } from 'aws-cdk-lib';
30
- import { FargateToKinesisStreamsProps } from '@aws-solutions-constructs/aws-fargate-kinesisstreams';
31
- import * as fargate from 'aws-cdk-lib/aws-fargate';
32
-
33
- new FargateToKinesisStreams(this, 'FargateToKinesisStreams', {
34
- publicApi: true,
35
- ecrRepositoryArn: "arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo",
36
- });
37
- ```
38
-
39
- Python
40
- ``` python
41
- from aws_solutions_constructs.aws_fargate_kinesisstreams import FargateToKinesisStreams
42
- from aws_cdk import (
43
- aws_fargate as _fargate,
44
- Stack
45
- )
46
- from constructs import Construct
47
-
48
- FargateToKinesisStreams(self, 'FargateToKinesisStreams',
49
- public_api=True,
50
- ecr_repository_arn="arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo"
51
- )
52
- ```
53
-
54
- Java
55
- ``` java
56
- import software.constructs.Construct;
57
-
58
- import software.amazon.awscdk.Stack;
59
- import software.amazon.awscdk.StackProps;
60
- import software.amazon.awscdk.services.fargate.*;
61
- import software.amazon.awscdk.services.fargate.eventsources.*;
62
- import software.amazon.awscdk.services.fargate.Runtime;
63
- import software.amazon.awsconstructs.services.fargatekinesisstreams.*;
64
-
65
- new FargateToKinesisStreams(this, "FargateToKinesisStreams", new FargateToKinesisStreamsProps.Builder()
66
- .publicApi(true)
67
- .ecrRepositoryArn("arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo")
68
- .build());
69
- ```
70
-
71
- ## Pattern Construct Props
72
-
73
- | **Name** | **Type** | **Description** |
74
- |:-------------|:----------------|-----------------|
75
- | publicApi | `boolean` | True if the VPC provisioned by this construct should contain Public/Private Subnets, otherwise False for the VPC to contain Isolated Subnets only. Note this property is ignored if an existing VPC is specified in the `existingVpc` property. |
76
- | vpcProps? | [`ec2.VpcProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.VpcProps.html) | Optional custom properties for a new VPC the construct will create. Providing both this and `existingVpc` is an error. An Amazon Kinesis Streams Interface Endpoint will be added to this VPC. |
77
- | existingVpc? | [`ec2.IVpc`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html) | An existing VPC in which to deploy the Fargate Service. Providing both this and `vpcProps` is an error. If the client provides an existing Fargate Service in the `existingFargateServiceObject` property, this value must be the VPC where the service is running. An Amazon Kinesis Streams Interface Endpoint will be added to this VPC. |
78
- | clusterProps? | [`ecs.ClusterProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ClusterProps.html) | Optional properties to create a new ECS cluster. To provide an existing cluster, use the cluster attribute of fargateServiceProps. |
79
- | ecrRepositoryArn? | `string` | The arn of an ECR Repository containing the image to use to generate the containers. Either this or the image property of containerDefinitionProps must be provided. format: arn:aws:ecr:*region*:*account number*:repository/*Repository Name* |
80
- | ecrImageVersion? | `string` | The version of the image to use from the repository. Defaults to 'Latest' |
81
- | containerDefinitionProps? | [`ecs.ContainerDefinitionProps \| any`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ContainerDefinitionProps.html) | Optional props to define the container created for the Fargate Service. (defaults found in fargate-defaults.ts) |
82
- | fargateTaskDefinitionProps? | [`ecs.FargateTaskDefinitionProps \| any`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateTaskDefinitionProps.html) | Optional props to define the Fargate Task Definition for this construct. (defaults found in fargate-defaults.ts) |
83
- | fargateServiceProps? | [`ecs.FargateServiceProps \| any`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateServiceProps.html) | Optional values to override default Fargate Task definition properties (fargate-defaults.ts). The construct will default to launching the service is the most isolated subnets available (precedence: Isolated, Private and Public). Override those and other defaults here. |
84
- | existingFargateServiceObject? | [`ecs.FargateService`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateService.html) | A Fargate Service already instantiated (probably by another Solutions Construct). If this is specified, then no props defining a new service can be provided, including: ecrImageVersion, containerDefinitionProps, fargateTaskDefinitionProps, ecrRepositoryArn, fargateServiceProps, clusterProps |
85
- | existingContainerDefinitionObject? | [`ecs.ContainerDefinition`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ContainerDefinition.html) | A container definition already instantiated as part of a Fargate service. This must be the container in the `existingFargateServiceObject`. |
86
- |existingStreamObj?|[`kinesis.Stream`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kinesis.Stream.html) | Existing instance of a Kinesis Data Stream. Providing both this and `kinesisStreamProps` will cause an error. |
87
- |kinesisStreamProps?|[`kinesis.StreamProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kinesis.StreamProps.html) | Optional user-provided props to override the default props for the Kinesis Data Stream. Providing both this and `existingStreamObj` will cause an error. |
88
- | createCloudWatchAlarms |`boolean` | Whether to create recommended CloudWatch Alarms for the Kinesis Stream (defaults to true). |
89
- | streamEnvironmentVariableName? | `string` | Optional Name to override the Fargate Service default environment variable name that holds the Kinesis Data Stream name value. Default: KINESIS_DATASTREAM_NAME |
90
-
91
- ## Pattern Properties
92
-
93
- | **Name** | **Type** | **Description** |
94
- |:-------------|:----------------|-----------------|
95
- | vpc | [`ec2.IVpc`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html) | The new or existing VPC used by the construct. |
96
- | service | [`ecs.FargateService`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateService.html) | The new or existing AWS Fargate service used by this construct. |
97
- | container | [`ecs.ContainerDefinition`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ContainerDefinition.html) | The container associated with the AWS Fargate service in the service property. |
98
- | kinesisStream | [`kinesis.Stream`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kinesis.Stream.html) | The new or existing Kinesis Data Stream used by this construct. |
99
- | cloudwatchAlarms? | [`cloudwatch.Alarm[]`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch.Alarm.html) | Returns the CloudWatch Alarms created to monitor the Kinesis Data Stream.|
100
-
101
- ## Default settings
102
-
103
- Out of the box implementation of the Construct without any overrides will set the following defaults:
104
-
105
- ### AWS Fargate Service
106
- * An AWS Fargate Service running in the isolated subnets of a new VPC
107
- * Minimally-permissive IAM role for the Fargate Service to put records on the Kinesis Data Stream
108
- * Sets an Environment Variable named KINESIS_DATASTREAM_NAME that holds the Kinesis Data Stream Name, which is a required property of the Kinesis Data Streams SDK when making calls to it
109
-
110
- ### Amazon Kinesis Stream
111
- * Enable server-side encryption for the Kinesis Data Stream using an AWS Managed CMK
112
- * Deploy best practices CloudWatch Alarms for the Kinesis Data Stream
113
- * An Interface Endpoint on the VPC for private communication between the Fargate Service and the Kinesis Data Stream
114
-
115
- ## Architecture
116
- ![Architecture Diagram](architecture.png)
117
-
118
- ***
119
- &copy; Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
1
+ Documentation for this pattern can be found [here](https://github.com/awslabs/aws-solutions-constructs/blob/main/source/patterns/%40aws-solutions-constructs/aws-fargate-kinesisstreams/README.adoc)
package/lib/index.js CHANGED
@@ -69,5 +69,5 @@ class FargateToKinesisStreams extends constructs_1.Construct {
69
69
  }
70
70
  exports.FargateToKinesisStreams = FargateToKinesisStreams;
71
71
  _a = JSII_RTTI_SYMBOL_1;
72
- FargateToKinesisStreams[_a] = { fqn: "@aws-solutions-constructs/aws-fargate-kinesisstreams.FargateToKinesisStreams", version: "2.85.2" };
72
+ FargateToKinesisStreams[_a] = { fqn: "@aws-solutions-constructs/aws-fargate-kinesisstreams.FargateToKinesisStreams", version: "2.85.4" };
73
73
  //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;;;AAkBA,2DAA2D;AAC3D,wFAAwF;AACxF,2CAAuC;AAgHvC;;GAEG;AACH,MAAa,uBAAwB,SAAQ,sBAAS;IAOlD;;;;;;;OAOG;IACH,YAAY,KAAgB,EAAE,EAAU,EAAE,KAAmC;QAC3E,KAAK,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACjB,QAAQ,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;QAClC,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC9B,QAAQ,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAC;QAExC,gBAAgB;QAChB,IAAI,CAAC,GAAG,GAAG,QAAQ,CAAC,QAAQ,CAAC,KAAK,EAAE;YAClC,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,eAAe,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,4BAA4B,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,uBAAuB,EAAE;YAC/G,YAAY,EAAE,KAAK,CAAC,QAAQ;YAC5B,iBAAiB,EAAE,EAAE,kBAAkB,EAAE,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE;SACxE,CAAC,CAAC;QAEH,4DAA4D;QAC5D,QAAQ,CAAC,qBAAqB,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,oBAAoB,CAAC,eAAe,CAAC,CAAC;QAE/F,4BAA4B;QAC5B,IAAI,KAAK,CAAC,4BAA4B,EAAE,CAAC;YACvC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,4BAA4B,CAAC;YAClD,4DAA4D;YAC5D,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,iCAAkC,CAAC;QAC5D,CAAC;aAAM,CAAC;YACN,MAAM,4BAA4B,GAAG,QAAQ,CAAC,oBAAoB,CAAC,KAAK,EAAE,EAAE,EAAE;gBAC5E,YAAY,EAAG,IAAI,CAAC,GAAG;gBACvB,kBAAkB,EAAE,KAAK,CAAC,YAAY;gBACtC,gBAAgB,EAAE,KAAK,CAAC,gBAAgB;gBACxC,eAAe,EAAE,KAAK,CAAC,eAAe;gBACtC,gCAAgC,EAAE,KAAK,CAAC,0BAA0B;gBAClE,8BAA8B,EAAE,KAAK,CAAC,wBAAwB;gBAC9D,yBAAyB,EAAE,KAAK,CAAC,mBAAmB;aACrD,CAAC,CAAC;YACH,IAAI,CAAC,OAAO,GAAG,4BAA4B,CAAC,OAAO,CAAC;YACpD,IAAI,CAAC,SAAS,GAAG,4BAA4B,CAAC,mBAAmB,CAAC;QACpE,CAAC;QAED,2BAA2B;QAC3B,IAAI,CAAC,aAAa,GAAG,QAAQ,CAAC,kBAAkB,CAAC,IAAI,EAAE;YACrD,iBAAiB,EAAE,KAAK,CAAC,iBAAiB;YAC1C,kBAAkB,EAAE,KAAK,CAAC,kBAAkB;SAC7C,CAAC,CAAC;QAEH,4CAA4C;QAC5C,MAAM,iCAAiC,GAAG,KAAK,CAAC,6BAA6B,IAAI,yBAAyB,CAAC;QAC3G,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,iCAAiC,EAAE,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAEhG,sEAAsE;QACtE,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAEpE,qEAAqE;QACrE,IAAI,KAAK,CAAC,sBAAsB,KAAK,SAAS,IAAI,KAAK,CAAC,sBAAsB,EAAE,CAAC;YAC/E,IAAI,CAAC,gBAAgB,GAAG,QAAQ,CAAC,0BAA0B,CAAC,IAAI,CAAC,CAAC;QACpE,CAAC;IACH,CAAC;;AApEL,0DAqEC","sourcesContent":["/**\n *  Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n *\n *  Licensed under the Apache License, Version 2.0 (the \"License\"). You may not use this file except in compliance\n *  with the License. A copy of the License is located at\n *\n *      http://www.apache.org/licenses/LICENSE-2.0\n *\n *  or in the 'license' file accompanying this file. This file is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES\n *  OR CONDITIONS OF ANY KIND, express or implied. See the License for the specific language governing permissions\n *  and limitations under the License.\n */\n\n// Imports\nimport * as cloudwatch from 'aws-cdk-lib/aws-cloudwatch';\nimport * as ec2 from \"aws-cdk-lib/aws-ec2\";\nimport * as ecs from \"aws-cdk-lib/aws-ecs\";\nimport * as kinesis from 'aws-cdk-lib/aws-kinesis';\nimport * as defaults from '@aws-solutions-constructs/core';\n// Note: To ensure CDKv2 compatibility, keep the import statement for Construct separate\nimport { Construct } from 'constructs';\n\n/**\n * The properties for the FargateToKinesisStreams class.\n */\nexport interface FargateToKinesisStreamsProps {\n  /**\n   * True if the VPC provisioned by this construct should contain Public/Private Subnets,\n   * otherwise False for the VPC to contain Isolated Subnets only.\n   *\n   * Note this property is ignored if an existing VPC is specified in the `existingVpc` property.\n   */\n  readonly publicApi: boolean;\n  /**\n   * Optional custom properties for a new VPC the construct will create. Providing both this and `existingVpc` is an error.\n   *\n   * An Amazon Kinesis Streams Interface Endpoint will be added to this VPC.\n   *\n   * @default - None\n   */\n  readonly vpcProps?: ec2.VpcProps;\n  /**\n   * An existing VPC in which to deploy the Fargate Service. Providing both this and `vpcProps` is an error.\n   * If the client provides an existing Fargate Service in the `existingFargateServiceObject` property,\n   * this value must be the VPC where the service is running.\n   *\n   * An Amazon Kinesis Streams Interface Endpoint will be added to this VPC.\n   *\n   * @default - None\n   */\n  readonly existingVpc?: ec2.IVpc;\n  /**\n   * Optional properties to create a new ECS cluster. To provide an existing cluster, use the cluster attribute of the `fargateServiceProps` property.\n   */\n  readonly clusterProps?: ecs.ClusterProps;\n  /**\n   * The arn of an ECR Repository containing the image to use to generate the containers.\n   *\n   * Either this or the image property of the `containerDefinitionProps` property must be provided.\n   *\n   * format:\n   *   arn:aws:ecr:[region]:[account number]:repository/[Repository Name]\n   */\n  readonly ecrRepositoryArn?: string;\n  /**\n   * The version of the image to use from the repository.\n   *\n   * @default - 'latest'\n   */\n  readonly ecrImageVersion?: string;\n  /*\n   * Optional props to define the container created for the Fargate Service\n   *\n   * defaults - fargate-defaults.ts\n   */\n  readonly containerDefinitionProps?: ecs.ContainerDefinitionProps | any;\n  /*\n   * Optional props to define the Fargate Task Definition for this construct\n   *\n   * defaults - fargate-defaults.ts\n   */\n  readonly fargateTaskDefinitionProps?: ecs.FargateTaskDefinitionProps | any;\n  /**\n   * Optional values to override default Fargate Task definition properties (fargate-defaults.ts).\n   * The construct will default to launching the service is the most isolated subnets available (precedence: Isolated, Private and Public).\n   * Override those and other defaults here.\n   *\n   * defaults - fargate-defaults.ts\n   */\n  readonly fargateServiceProps?: ecs.FargateServiceProps | any;\n  /**\n   * A Fargate Service already instantiated. If this is specified, then no props defining a new service can be provided, including:\n   *  ecrImageVersion, containerDefinitionProps, fargateTaskDefinitionProps, ecrRepositoryArn, fargateServiceProps, clusterProps.\n   *\n   * Note - If this property is set, then the `existingContainerDefinitionObject` property must be set as well.\n   *\n   * @default - None\n   */\n  readonly existingFargateServiceObject?: ecs.FargateService;\n  /*\n   * A container definition already instantiated as part of a Fargate service.\n   * This must be the container used in the `existingFargateServiceObject` property.\n   *\n   * @default - None\n   */\n    readonly existingContainerDefinitionObject?: ecs.ContainerDefinition;\n  /**\n   * Existing instance of Kinesis Stream, providing both this and `kinesisStreamProps` will cause an error.\n   *\n   * @default - None\n   */\n  readonly existingStreamObj?: kinesis.Stream;\n  /**\n   * Optional user-provided props to override the default props for the Kinesis stream.\n   *\n   * @default - Default props are used.\n   */\n  readonly kinesisStreamProps?: kinesis.StreamProps;\n  /**\n   * Whether to create recommended CloudWatch alarms for the Kinesis Stream.\n   *\n   * @default - Alarms are created\n   */\n  readonly createCloudWatchAlarms?: boolean;\n  /**\n   * Optional Name to override the Fargate Service default environment variable name that holds the Kinesis Data Stream name value.\n   *\n   * @default - KINESIS_DATASTREAM_NAME\n   */\n  readonly streamEnvironmentVariableName?: string;\n}\n\n/**\n * @summary The FargateToKinesisStream class.\n */\nexport class FargateToKinesisStreams extends Construct {\n    public readonly vpc?: ec2.IVpc;\n    public readonly service: ecs.FargateService;\n    public readonly container: ecs.ContainerDefinition;\n    public readonly kinesisStream: kinesis.Stream;\n    public readonly cloudwatchAlarms?: cloudwatch.Alarm[];\n\n    /**\n     * @summary Constructs a new instance of the KinesisStreamsToFargate class.\n     * @param {cdk.App} scope - represents the scope for all the resources.\n     * @param {string} id - this is a a scope-unique id.\n     * @param {FargateToKinesisStreamsProps} props - user provided props for the construct\n     * @since 0.8.0\n     * @access public\n     */\n    constructor(scope: Construct, id: string, props: FargateToKinesisStreamsProps) {\n      super(scope, id);\n      defaults.CheckFargateProps(props);\n      defaults.CheckVpcProps(props);\n      defaults.CheckKinesisStreamProps(props);\n\n      // Setup the VPC\n      this.vpc = defaults.buildVpc(scope, {\n        existingVpc: props.existingVpc,\n        defaultVpcProps: props.publicApi ? defaults.DefaultPublicPrivateVpcProps() : defaults.DefaultIsolatedVpcProps(),\n        userVpcProps: props.vpcProps,\n        constructVpcProps: { enableDnsHostnames: true, enableDnsSupport: true }\n      });\n\n      // Add the interface endpoint to the VPC for Kinesis Streams\n      defaults.AddAwsServiceEndpoint(scope, this.vpc, defaults.ServiceEndpointTypes.KINESIS_STREAMS);\n\n      // Setup the Fargate Service\n      if (props.existingFargateServiceObject) {\n        this.service = props.existingFargateServiceObject;\n        // CheckFargateProps confirms that the container is provided\n        this.container = props.existingContainerDefinitionObject!;\n      } else {\n        const createFargateServiceResponse = defaults.CreateFargateService(scope, id, {\n          constructVpc:  this.vpc,\n          clientClusterProps: props.clusterProps,\n          ecrRepositoryArn: props.ecrRepositoryArn,\n          ecrImageVersion: props.ecrImageVersion,\n          clientFargateTaskDefinitionProps: props.fargateTaskDefinitionProps,\n          clientContainerDefinitionProps: props.containerDefinitionProps,\n          clientFargateServiceProps: props.fargateServiceProps\n        });\n        this.service = createFargateServiceResponse.service;\n        this.container = createFargateServiceResponse.containerDefinition;\n      }\n\n      // Setup the Kinesis Stream\n      this.kinesisStream = defaults.buildKinesisStream(this, {\n        existingStreamObj: props.existingStreamObj,\n        kinesisStreamProps: props.kinesisStreamProps\n      });\n\n      // Configure container environment variables\n      const streamNameEnvironmentVariableName = props.streamEnvironmentVariableName || 'KINESIS_DATASTREAM_NAME';\n      this.container.addEnvironment(streamNameEnvironmentVariableName, this.kinesisStream.streamName);\n\n      // Grant the Fargate Service permission to write to the Kinesis Stream\n      this.kinesisStream.grantWrite(this.service.taskDefinition.taskRole);\n\n      // By default, deploy CloudWatch Alarms to monitor the Kinesis Stream\n      if (props.createCloudWatchAlarms === undefined || props.createCloudWatchAlarms) {\n        this.cloudwatchAlarms = defaults.buildKinesisStreamCWAlarms(this);\n      }\n    }\n}"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aws-solutions-constructs/aws-fargate-kinesisstreams",
3
- "version": "2.85.2",
3
+ "version": "2.85.4",
4
4
  "description": "CDK Constructs for AWS Fargate to an Amazon Kinesis Data Stream ",
5
5
  "main": "lib/index.js",
6
6
  "types": "lib/index.d.ts",
@@ -22,12 +22,13 @@
22
22
  "test": "jest --coverage",
23
23
  "clean": "tsc -b --clean",
24
24
  "watch": "tsc -b -w",
25
+ "asciidoc": "asciidoctor --failure-level WARNING -o /dev/null README.adoc",
25
26
  "integ": "integ-runner --update-on-failed",
26
27
  "integ-no-clean": "integ-runner --update-on-failed --no-clean",
27
28
  "integ-assert": "integ-runner",
28
29
  "jsii": "jsii",
29
30
  "jsii-pacmak": "jsii-pacmak",
30
- "build+lint+test": "npm run jsii && npm run lint && npm test && npm run integ-assert",
31
+ "build+lint+test": "npm run jsii && npm run lint && npm run asciidoc && npm test && npm run integ-assert",
31
32
  "blt": "npm run build+lint+test",
32
33
  "snapshot-update": "npm run jsii && npm test -- -u && npm run integ-assert"
33
34
  },
@@ -54,7 +55,7 @@
54
55
  }
55
56
  },
56
57
  "dependencies": {
57
- "@aws-solutions-constructs/core": "2.85.2",
58
+ "@aws-solutions-constructs/core": "2.85.4",
58
59
  "constructs": "^10.0.0"
59
60
  },
60
61
  "devDependencies": {
@@ -78,7 +79,7 @@
78
79
  ]
79
80
  },
80
81
  "peerDependencies": {
81
- "@aws-solutions-constructs/core": "2.85.2",
82
+ "@aws-solutions-constructs/core": "2.85.4",
82
83
  "constructs": "^10.0.0",
83
84
  "aws-cdk-lib": "^2.193.0"
84
85
  },