@aws-solutions-constructs/aws-fargate-stepfunctions 2.85.1 → 2.85.3

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.1",
11
+ "@aws-solutions-constructs/core": "2.85.3",
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-stepfunctions",
3995
3995
  "readme": {
3996
- "markdown": "# aws-fargate-stepfunctions 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> All classes are under active development and subject to non-backward compatible changes or removal in any\n> future version. These are not subject to the [Semantic Versioning](https://semver.org/) model.\n> This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.\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_stepfunctions`|\n|![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-fargate-stepfunctions`|\n|![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.fargatestepfunctions`|\n\n## Overview\nThis AWS Solutions Construct implements an AWS Fargate service that can execute an AWS Step Functions state machine\n\nHere is a minimal deployable pattern definition:\n\nTypescript\n``` typescript\nimport { Construct } from 'constructs';\nimport { Stack, StackProps } from 'aws-cdk-lib';\nimport { FargateToStepfunctions, FargateToStepfunctionsProps } from '@aws-solutions-constructs/aws-fargate-stepfunctions';\nimport * as stepfunctions from 'aws-cdk-lib/aws-stepfunctions';\n\nconst startState = new stepfunctions.Pass(this, 'StartState');\n\nconst constructProps: FargateToStepfunctionsProps = {\n publicApi: true,\n ecrRepositoryArn: \"arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo\",\n stateMachineProps: {\n definition: startState\n }\n};\n\nnew FargateToStepfunctions(this, 'test-construct', constructProps);\n```\n\nPython\n``` python\nfrom aws_solutions_constructs.aws_fargate_stepfunctions import FargateToStepfunctions, FargateToStepfunctionsProps\nfrom aws_cdk import (\n aws_stepfunctions as stepfunctions,\n Stack\n)\nfrom constructs import Construct\n\nstart_state = stepfunctions.Pass(self, 'start_state')\n\nFargateToStepfunctions(self, 'test_construct',\n public_api=True,\n ecr_repository_arn=\"arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo\",\n state_machine_props=stepfunctions.StateMachineProps(\n definition=start_state))\n```\n\nJava\n``` java\nimport software.constructs.Construct;\n\nimport software.amazon.awscdk.Stack;\nimport software.amazon.awscdk.StackProps;\nimport software.amazon.awsconstructs.services.fargatestepfunctions.*;\nimport software.amazon.awscdk.services.stepfunctions.*;\n\nstart_state = stepfunctions.Pass(self, 'start_state')\n\nnew FargateToStepfunctions(this, \"test-construct\", new FargateToStepfunctionsProps.Builder()\n .publicApi(true)\n .ecrRepositoryArn(\"arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo\")\n .stateMachineProps(new StateMachineProps.Builder()\n .definition(startState)\n .build()\n .build());\n```\n\n## Pattern Construct Props\n\n| **Name** | **Type** | **Description** |\n|:-------------|:----------------|-----------------|\n| publicApi | `boolean` | Whether the construct is deploying a private or public API. This has implications for the VPC. |\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 VPC the construct will create. This VPC will be used by any Private Hosted Zone the construct creates (that's why loadBalancerProps and privateHostedZoneProps can't include a VPC). Providing both this and existingVpc is an error. |\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 construct. Providing both this and vpcProps is an error. If the client provides an existing load balancer and/or existing Private Hosted Zone, those constructs must exist in 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|stateMachineProps|[`sfn.StateMachineProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.StateMachineProps.html)|User provided props to override the default props for sfn.StateMachine.|\n| createCloudWatchAlarms? | `boolean`|Whether to create recommended CloudWatch alarms. Default is true.|\n|logGroupProps?|[`logs.LogGroupProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs.LogGroupProps.html)|Optional user provided props to override the default props for for the CloudWatchLogs LogGroup.|\n|stateMachineEnvironmentVariableName?|`string`|Optional Name for the container environment variable set to the ARN of the state machine. Default: STATE_MACHINE_ARN |\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 VPC used by the construct (whether created by the construct or provided by the client) |\n| service | [`ecs.FargateService`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateService.html) | The AWS Fargate service used by this construct (whether created by this construct or passed to this construct at initialization) |\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| stateMachine| [`sfn.StateMachine`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.StateMachine.html)|Returns an instance of `sfn.StateMachine` created by the construct.|\n| stateMachineLogGroup|[`logs.ILogGroup`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs.ILogGroup.html)|Returns an instance of the `logs.ILogGroup` created by the construct for StateMachine.|\n| cloudwatchAlarms? | [`cloudwatch.Alarm[]`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch.Alarm.html)|Returns a list of `cloudwatch.Alarm` created by the construct.|\n\n## Default settings\n\nOut of the box implementation of the Construct without any override will set the following defaults:\n\n### AWS Fargate Service\n* Sets up an AWS Fargate service\n * Uses the existing service if provided\n * Creates a new service if none provided.\n * Service will run in isolated subnets if available, then private subnets if available and finally public subnets\n* Adds an environment variable to the container containing the ARN of the state machine\n * Default name is `STATE_MACHINE_ARN`\n* Add permissions to the container IAM role allowing it to start the execution of a state machine\n\n### AWS Step Functions\n* Sets up an AWS Step Functions state machine\n * Uses an existing state machine if one is provided, otherwise creates a new one\n* Adds an Interface Endpoint to the VPC for Step Functions (the service by default runs in Isolated or Private subnets)\n* Enables CloudWatch logging\n\n## Architecture\n![Architecture Diagram](architecture.png)\n\n***\n&copy; Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n"
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-stepfunctions/README.adoc)\n"
3997
3997
  },
3998
3998
  "repository": {
3999
3999
  "directory": "source/patterns/@aws-solutions-constructs/aws-fargate-stepfunctions",
@@ -4394,6 +4394,6 @@
4394
4394
  "symbolId": "lib/index:FargateToStepfunctionsProps"
4395
4395
  }
4396
4396
  },
4397
- "version": "2.85.1",
4398
- "fingerprint": "B1oEBvc9vZwO3iyMGm4yIDJ2YYaXedSZrqRCGCB4Mz8="
4397
+ "version": "2.85.3",
4398
+ "fingerprint": "Pn3abtyI4NbsMcF85r8TXNo0VYEj4TCm4qpy/e+92VE="
4399
4399
  }
package/README.adoc ADDED
@@ -0,0 +1,267 @@
1
+ //!!NODE_ROOT <section>
2
+ //== aws-fargate-stepfunctions module
3
+
4
+ [.topic]
5
+ = aws-fargate-stepfunctions
6
+ :info_doctype: section
7
+ :info_title: aws-fargate-stepfunctions
8
+
9
+
10
+ image:https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge[Stability:Experimental]
11
+
12
+ ____
13
+ All classes are under active development and subject to non-backward
14
+ compatible changes or removal in any future version. These are not
15
+ subject to the https://semver.org/[Semantic Versioning] model. This
16
+ means that while you may use them, you may need to update your source
17
+ code when upgrading to a newer version of this package.
18
+ ____
19
+
20
+ [width="100%",cols="<50%,<50%",options="header",]
21
+ |===
22
+ |*Reference Documentation*:
23
+ |https://docs.aws.amazon.com/solutions/latest/constructs/
24
+ |===
25
+
26
+ [width="100%",cols="<46%,54%",options="header",]
27
+ |===
28
+ |*Language* |*Package*
29
+ |image:https://docs.aws.amazon.com/cdk/api/latest/img/python32.png[Python
30
+ Logo] Python
31
+ |`aws_solutions_constructs.aws_fargate_stepfunctions`
32
+
33
+ |image:https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png[Typescript
34
+ Logo] Typescript |`@aws-solutions-constructs/aws-fargate-stepfunctions`
35
+
36
+ |image:https://docs.aws.amazon.com/cdk/api/latest/img/java32.png[Java
37
+ Logo] Java
38
+ |`software.amazon.awsconstructs.services.fargatestepfunctions`
39
+ |===
40
+
41
+ == Overview
42
+
43
+ This AWS Solutions Construct implements an AWS Fargate service that can
44
+ execute an AWS Step Functions state machine
45
+
46
+ Here is a minimal deployable pattern definition:
47
+
48
+ ====
49
+ [role="tablist"]
50
+ Typescript::
51
+ +
52
+ [source,typescript]
53
+ ----
54
+ import { Construct } from 'constructs';
55
+ import { Stack, StackProps } from 'aws-cdk-lib';
56
+ import { FargateToStepfunctions, FargateToStepfunctionsProps } from '@aws-solutions-constructs/aws-fargate-stepfunctions';
57
+ import * as stepfunctions from 'aws-cdk-lib/aws-stepfunctions';
58
+
59
+ const startState = new stepfunctions.Pass(this, 'StartState');
60
+
61
+ const constructProps: FargateToStepfunctionsProps = {
62
+ publicApi: true,
63
+ ecrRepositoryArn: "arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo",
64
+ stateMachineProps: {
65
+ definition: startState
66
+ }
67
+ };
68
+
69
+ new FargateToStepfunctions(this, 'test-construct', constructProps);
70
+ ----
71
+
72
+ Python::
73
+ +
74
+ [source,python]
75
+ ----
76
+ from aws_solutions_constructs.aws_fargate_stepfunctions import FargateToStepfunctions, FargateToStepfunctionsProps
77
+ from aws_cdk import (
78
+ aws_stepfunctions as stepfunctions,
79
+ Stack
80
+ )
81
+ from constructs import Construct
82
+
83
+ start_state = stepfunctions.Pass(self, 'start_state')
84
+
85
+ FargateToStepfunctions(self, 'test_construct',
86
+ public_api=True,
87
+ ecr_repository_arn="arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo",
88
+ state_machine_props=stepfunctions.StateMachineProps(
89
+ definition=start_state))
90
+ ----
91
+
92
+ Java::
93
+ +
94
+ [source,java]
95
+ ----
96
+ import software.constructs.Construct;
97
+
98
+ import software.amazon.awscdk.Stack;
99
+ import software.amazon.awscdk.StackProps;
100
+ import software.amazon.awsconstructs.services.fargatestepfunctions.*;
101
+ import software.amazon.awscdk.services.stepfunctions.*;
102
+
103
+ start_state = stepfunctions.Pass(self, 'start_state')
104
+
105
+ new FargateToStepfunctions(this, "test-construct", new FargateToStepfunctionsProps.Builder()
106
+ .publicApi(true)
107
+ .ecrRepositoryArn("arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo")
108
+ .stateMachineProps(new StateMachineProps.Builder()
109
+ .definition(startState)
110
+ .build()
111
+ .build());
112
+ ----
113
+ ====
114
+
115
+ == Pattern Construct Props
116
+
117
+ [width="100%",cols="<30%,<35%,35%",options="header",]
118
+ |===
119
+ |*Name* |*Type* |*Description*
120
+ |publicApi |`boolean` |Whether the construct is deploying a private or
121
+ public API. This has implications for the VPC.
122
+
123
+ |vpcProps?
124
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.VpcProps.html[`ec2.VpcProps`]
125
+ |Optional custom properties for a VPC the construct will create. This
126
+ VPC will be used by any Private Hosted Zone the construct creates
127
+ (that’s why loadBalancerProps and privateHostedZoneProps can’t include a
128
+ VPC). Providing both this and existingVpc is an error.
129
+
130
+ |existingVpc?
131
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html[`ec2.IVpc`]
132
+ |An existing VPC in which to deploy the construct. Providing both this
133
+ and vpcProps is an error. If the client provides an existing load
134
+ balancer and/or existing Private Hosted Zone, those constructs must
135
+ exist in this VPC.
136
+
137
+ |clusterProps?
138
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ClusterProps.html[`ecs.ClusterProps`]
139
+ |Optional properties to create a new ECS cluster. To provide an existing
140
+ cluster, use the cluster attribute of fargateServiceProps.
141
+
142
+ |ecrRepositoryArn? |`string` |The arn of an ECR Repository containing
143
+ the image to use to generate the containers. Either this or the image
144
+ property of containerDefinitionProps must be provided. format:
145
+ arn:aws:ecr:_region_:_account number_:repository/_Repository Name_
146
+
147
+ |ecrImageVersion? |`string` |The version of the image to use from the
148
+ repository. Defaults to '`Latest`'
149
+
150
+ |containerDefinitionProps?
151
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ContainerDefinitionProps.html[`ecs.ContainerDefinitionProps`] {vbar} any
152
+ |Optional props to define the container created for the Fargate Service
153
+ (defaults found in fargate-defaults.ts)
154
+
155
+ |fargateTaskDefinitionProps?
156
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateTaskDefinitionProps.html[`ecs.FargateTaskDefinitionProps`] {vbar} any
157
+ |Optional props to define the Fargate Task Definition for this construct
158
+ (defaults found in fargate-defaults.ts)
159
+
160
+ |fargateServiceProps?
161
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateServiceProps.html[`ecs.FargateServiceProps`] {vbar} any
162
+ |Optional values to override default Fargate Task definition properties
163
+ (fargate-defaults.ts). The construct will default to launching the
164
+ service is the most isolated subnets available (precedence: Isolated,
165
+ Private and Public). Override those and other defaults here.
166
+
167
+ |existingFargateServiceObject?
168
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateService.html[`ecs.FargateService`]
169
+ |A Fargate Service already instantiated (probably by another Solutions
170
+ Construct). If this is specified, then no props defining a new service
171
+ can be provided, including: ecrImageVersion, containerDefinitionProps,
172
+ fargateTaskDefinitionProps, ecrRepositoryArn, fargateServiceProps,
173
+ clusterProps
174
+
175
+ |existingContainerDefinitionObject?
176
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ContainerDefinition.html[`ecs.ContainerDefinition`]
177
+ |A container definition already instantiated as part of a Fargate
178
+ service. This must be the container in the existingFargateServiceObject
179
+
180
+ |stateMachineProps
181
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.StateMachineProps.html[`sfn.StateMachineProps`]
182
+ |User provided props to override the default props for sfn.StateMachine.
183
+
184
+ |createCloudWatchAlarms? |`boolean` |Whether to create recommended
185
+ CloudWatch alarms. Default is true.
186
+
187
+ |logGroupProps?
188
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs.LogGroupProps.html[`logs.LogGroupProps`]
189
+ |Optional user provided props to override the default props for for the
190
+ CloudWatchLogs LogGroup.
191
+
192
+ |stateMachineEnvironmentVariableName? |`string` |Optional Name for the
193
+ container environment variable set to the ARN of the state machine.
194
+ Default: STATE_MACHINE_ARN
195
+ |===
196
+
197
+ == Pattern Properties
198
+
199
+ [width="100%",cols="<30%,<35%,35%",options="header",]
200
+ |===
201
+ |*Name* |*Type* |*Description*
202
+ |vpc
203
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html[`ec2.IVpc`]
204
+ |The VPC used by the construct (whether created by the construct or
205
+ provided by the client)
206
+
207
+ |service
208
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateService.html[`ecs.FargateService`]
209
+ |The AWS Fargate service used by this construct (whether created by this
210
+ construct or passed to this construct at initialization)
211
+
212
+ |container
213
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ContainerDefinition.html[`ecs.ContainerDefinition`]
214
+ |The container associated with the AWS Fargate service in the service
215
+ property.
216
+
217
+ |stateMachine
218
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.StateMachine.html[`sfn.StateMachine`]
219
+ |Returns an instance of `sfn.StateMachine` created by the construct.
220
+
221
+ |stateMachineLogGroup
222
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs.ILogGroup.html[`logs.ILogGroup`]
223
+ |Returns an instance of the `logs.ILogGroup` created by the construct
224
+ for StateMachine.
225
+
226
+ |cloudwatchAlarms?
227
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch.Alarm.html[`cloudwatch.Alarm[\]`]
228
+ |Returns a list of `cloudwatch.Alarm` created by the construct.
229
+ |===
230
+
231
+ == Default settings
232
+
233
+ Out of the box implementation of the Construct without any override will
234
+ set the following defaults:
235
+
236
+ === AWS Fargate Service
237
+
238
+ * Sets up an AWS Fargate service
239
+ ** Uses the existing service if provided
240
+ ** Creates a new service if none provided.
241
+ *** Service will run in isolated subnets if available, then private
242
+ subnets if available and finally public subnets
243
+ * Adds an environment variable to the container containing the ARN of
244
+ the state machine
245
+ ** Default name is `STATE_MACHINE_ARN`
246
+ * Add permissions to the container IAM role allowing it to start the
247
+ execution of a state machine
248
+
249
+ === AWS Step Functions
250
+
251
+ * Sets up an AWS Step Functions state machine
252
+ ** Uses an existing state machine if one is provided, otherwise creates
253
+ a new one
254
+ * Adds an Interface Endpoint to the VPC for Step Functions (the service
255
+ by default runs in Isolated or Private subnets)
256
+ * Enables CloudWatch logging
257
+
258
+ == Architecture
259
+
260
+
261
+ image::aws-fargate-stepfunctions.png["Diagram showing the Fargate service, State Machine, log group and IAM roles created by the construct",scaledwidth=100%]
262
+
263
+ // github block
264
+
265
+ '''''
266
+
267
+ © Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
package/README.md CHANGED
@@ -1,142 +1 @@
1
- # aws-fargate-stepfunctions 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
- > All classes are under active development and subject to non-backward compatible changes or removal in any
9
- > future version. These are not subject to the [Semantic Versioning](https://semver.org/) model.
10
- > This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.
11
-
12
- ---
13
- <!--END STABILITY BANNER-->
14
-
15
- | **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|
16
- |:-------------|:-------------|
17
- <div style="height:8px"></div>
18
-
19
- | **Language** | **Package** |
20
- |:-------------|-----------------|
21
- |![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python|`aws_solutions_constructs.aws_fargate_stepfunctions`|
22
- |![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-fargate-stepfunctions`|
23
- |![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.fargatestepfunctions`|
24
-
25
- ## Overview
26
- This AWS Solutions Construct implements an AWS Fargate service that can execute an AWS Step Functions state machine
27
-
28
- Here is a minimal deployable pattern definition:
29
-
30
- Typescript
31
- ``` typescript
32
- import { Construct } from 'constructs';
33
- import { Stack, StackProps } from 'aws-cdk-lib';
34
- import { FargateToStepfunctions, FargateToStepfunctionsProps } from '@aws-solutions-constructs/aws-fargate-stepfunctions';
35
- import * as stepfunctions from 'aws-cdk-lib/aws-stepfunctions';
36
-
37
- const startState = new stepfunctions.Pass(this, 'StartState');
38
-
39
- const constructProps: FargateToStepfunctionsProps = {
40
- publicApi: true,
41
- ecrRepositoryArn: "arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo",
42
- stateMachineProps: {
43
- definition: startState
44
- }
45
- };
46
-
47
- new FargateToStepfunctions(this, 'test-construct', constructProps);
48
- ```
49
-
50
- Python
51
- ``` python
52
- from aws_solutions_constructs.aws_fargate_stepfunctions import FargateToStepfunctions, FargateToStepfunctionsProps
53
- from aws_cdk import (
54
- aws_stepfunctions as stepfunctions,
55
- Stack
56
- )
57
- from constructs import Construct
58
-
59
- start_state = stepfunctions.Pass(self, 'start_state')
60
-
61
- FargateToStepfunctions(self, 'test_construct',
62
- public_api=True,
63
- ecr_repository_arn="arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo",
64
- state_machine_props=stepfunctions.StateMachineProps(
65
- definition=start_state))
66
- ```
67
-
68
- Java
69
- ``` java
70
- import software.constructs.Construct;
71
-
72
- import software.amazon.awscdk.Stack;
73
- import software.amazon.awscdk.StackProps;
74
- import software.amazon.awsconstructs.services.fargatestepfunctions.*;
75
- import software.amazon.awscdk.services.stepfunctions.*;
76
-
77
- start_state = stepfunctions.Pass(self, 'start_state')
78
-
79
- new FargateToStepfunctions(this, "test-construct", new FargateToStepfunctionsProps.Builder()
80
- .publicApi(true)
81
- .ecrRepositoryArn("arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo")
82
- .stateMachineProps(new StateMachineProps.Builder()
83
- .definition(startState)
84
- .build()
85
- .build());
86
- ```
87
-
88
- ## Pattern Construct Props
89
-
90
- | **Name** | **Type** | **Description** |
91
- |:-------------|:----------------|-----------------|
92
- | publicApi | `boolean` | Whether the construct is deploying a private or public API. This has implications for the VPC. |
93
- | vpcProps? | [`ec2.VpcProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.VpcProps.html) | Optional custom properties for a VPC the construct will create. This VPC will be used by any Private Hosted Zone the construct creates (that's why loadBalancerProps and privateHostedZoneProps can't include a VPC). Providing both this and existingVpc is an error. |
94
- | 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 construct. Providing both this and vpcProps is an error. If the client provides an existing load balancer and/or existing Private Hosted Zone, those constructs must exist in this VPC. |
95
- | 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. |
96
- | 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* |
97
- | ecrImageVersion? | `string` | The version of the image to use from the repository. Defaults to 'Latest' |
98
- | 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) |
99
- | 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) |
100
- | 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. |
101
- |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 |
102
- |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 |
103
- |stateMachineProps|[`sfn.StateMachineProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.StateMachineProps.html)|User provided props to override the default props for sfn.StateMachine.|
104
- | createCloudWatchAlarms? | `boolean`|Whether to create recommended CloudWatch alarms. Default is true.|
105
- |logGroupProps?|[`logs.LogGroupProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs.LogGroupProps.html)|Optional user provided props to override the default props for for the CloudWatchLogs LogGroup.|
106
- |stateMachineEnvironmentVariableName?|`string`|Optional Name for the container environment variable set to the ARN of the state machine. Default: STATE_MACHINE_ARN |
107
-
108
- ## Pattern Properties
109
-
110
- | **Name** | **Type** | **Description** |
111
- |:-------------|:----------------|-----------------|
112
- | vpc | [`ec2.IVpc`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html) | The VPC used by the construct (whether created by the construct or provided by the client) |
113
- | service | [`ecs.FargateService`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateService.html) | The AWS Fargate service used by this construct (whether created by this construct or passed to this construct at initialization) |
114
- | 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. |
115
- | stateMachine| [`sfn.StateMachine`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.StateMachine.html)|Returns an instance of `sfn.StateMachine` created by the construct.|
116
- | stateMachineLogGroup|[`logs.ILogGroup`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs.ILogGroup.html)|Returns an instance of the `logs.ILogGroup` created by the construct for StateMachine.|
117
- | cloudwatchAlarms? | [`cloudwatch.Alarm[]`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch.Alarm.html)|Returns a list of `cloudwatch.Alarm` created by the construct.|
118
-
119
- ## Default settings
120
-
121
- Out of the box implementation of the Construct without any override will set the following defaults:
122
-
123
- ### AWS Fargate Service
124
- * Sets up an AWS Fargate service
125
- * Uses the existing service if provided
126
- * Creates a new service if none provided.
127
- * Service will run in isolated subnets if available, then private subnets if available and finally public subnets
128
- * Adds an environment variable to the container containing the ARN of the state machine
129
- * Default name is `STATE_MACHINE_ARN`
130
- * Add permissions to the container IAM role allowing it to start the execution of a state machine
131
-
132
- ### AWS Step Functions
133
- * Sets up an AWS Step Functions state machine
134
- * Uses an existing state machine if one is provided, otherwise creates a new one
135
- * Adds an Interface Endpoint to the VPC for Step Functions (the service by default runs in Isolated or Private subnets)
136
- * Enables CloudWatch logging
137
-
138
- ## Architecture
139
- ![Architecture Diagram](architecture.png)
140
-
141
- ***
142
- &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-stepfunctions/README.adoc)
package/lib/index.js CHANGED
@@ -65,5 +65,5 @@ class FargateToStepfunctions extends constructs_1.Construct {
65
65
  }
66
66
  exports.FargateToStepfunctions = FargateToStepfunctions;
67
67
  _a = JSII_RTTI_SYMBOL_1;
68
- FargateToStepfunctions[_a] = { fqn: "@aws-solutions-constructs/aws-fargate-stepfunctions.FargateToStepfunctions", version: "2.85.1" };
68
+ FargateToStepfunctions[_a] = { fqn: "@aws-solutions-constructs/aws-fargate-stepfunctions.FargateToStepfunctions", version: "2.85.3" };
69
69
  //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;;;AAAA;;;;;;;;;;;GAWG;AAEH,wFAAwF;AACxF,2CAAuC;AACvC,2DAA2D;AAmH3D,MAAa,sBAAuB,SAAQ,sBAAS;IAQnD,YAAY,KAAgB,EAAE,EAAU,EAAE,KAAkC;QAC1E,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,sBAAsB,CAAC,KAAK,CAAC,CAAC;QAEvC,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,QAAQ,CAAC,qBAAqB,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,oBAAoB,CAAC,cAAc,CAAC,CAAC;QAE9F,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,EAAE,IAAI,CAAC,GAAG;gBACtB,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,MAAM,yBAAyB,GAAG,QAAQ,CAAC,iBAAiB,CAAC,IAAI,EAAE,QAAQ,CAAC,aAAa,EAAE;YACzF,iBAAiB,EAAE,KAAK,CAAC,iBAAiB;YAC1C,aAAa,EAAE,KAAK,CAAC,aAAa;YAClC,sBAAsB,EAAE,KAAK,CAAC,sBAAsB;SACrD,CAAC,CAAC;QACH,IAAI,CAAC,YAAY,GAAG,yBAAyB,CAAC,YAAY,CAAC;QAC3D,IAAI,CAAC,oBAAoB,GAAG,yBAAyB,CAAC,QAAQ,CAAC;QAC/D,IAAI,CAAC,gBAAgB,GAAG,yBAAyB,CAAC,gBAAgB,CAAC;QAEnE,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAE5E,2BAA2B;QAC3B,MAAM,mCAAmC,GAAG,KAAK,CAAC,mCAAmC,IAAI,mBAAmB,CAAC;QAC7G,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,mCAAmC,EAAE,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;IACxG,CAAC;;AAvDH,wDAwDC","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// Note: To ensure CDKv2 compatibility, keep the import statement for Construct separate\nimport { Construct } from \"constructs\";\nimport * as defaults from \"@aws-solutions-constructs/core\";\nimport * as ecs from \"aws-cdk-lib/aws-ecs\";\nimport * as ec2 from \"aws-cdk-lib/aws-ec2\";\nimport * as sfn from 'aws-cdk-lib/aws-stepfunctions';\nimport * as logs from 'aws-cdk-lib/aws-logs';\nimport * as cloudwatch from 'aws-cdk-lib/aws-cloudwatch';\n\nexport interface FargateToStepfunctionsProps {\n  /**\n   * Whether the construct is deploying a private or public API. This has implications for the VPC deployed\n   * by this construct.\n   */\n  readonly publicApi: boolean;\n  /**\n   * Optional custom properties for a VPC the construct will create. This VPC will\n   * be used by the new Fargate service the construct creates (that's\n   * why targetGroupProps can't include a VPC). Providing\n   * both this and existingVpc is an error. A Step Functions Interface\n   * endpoint will be included in this VPC.\n   *\n   * @default - A set of defaults from vpc-defaults.ts: DefaultPublicPrivateVpcProps() for public APIs\n   * and DefaultIsolatedVpcProps() for private APIs.\n   */\n  readonly vpcProps?: ec2.VpcProps;\n  /**\n   * An existing VPC in which to deploy the construct. Providing both this and\n   * vpcProps is an error. If the client provides an existing Fargate service,\n   * this value must be the VPC where the service is running. A Step Functions Interface\n   * 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\n   */\n  readonly clusterProps?: ecs.ClusterProps;\n  /**\n   * The arn of an ECR Repository containing the image to use\n   * to generate the containers\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\n   * (fargate-defaults.ts). The construct will default to launching the service\n   * is the most isolated subnets available (precedence: Isolated, Private and\n   * Public). 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 (probably by another Solutions Construct). If\n   * this is specified, then no props defining a new service can be provided, including:\n   * existingImageObject, ecrImageVersion, containerDefinitionProps, fargateTaskDefinitionProps,\n   * ecrRepositoryArn, fargateServiceProps, clusterProps, existingClusterInterface. If this value\n   * is provided, then existingContainerDefinitionObject must be provided 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. This must\n   * be the container in the existingFargateServiceObject.\n   *\n   * @default - None\n   */\n  readonly existingContainerDefinitionObject?: ecs.ContainerDefinition;\n  /**\n   * User provided StateMachineProps to override the defaults\n   *\n   * @default - None\n   */\n  readonly stateMachineProps: sfn.StateMachineProps;\n  /**\n   * Whether to create recommended CloudWatch alarms\n   *\n   * @default - true\n   */\n  readonly createCloudWatchAlarms?: boolean;\n  /**\n   * User provided props to override the default props for the CloudWatchLogs LogGroup.\n   *\n   * @default - Default props are used\n   */\n  readonly logGroupProps?: logs.LogGroupProps;\n  /**\n   * Optional Name for the container environment variable set to the ARN of the state machine.\n   *\n   * @default - STATE_MACHINE_ARN\n   */\n  readonly stateMachineEnvironmentVariableName?: string;\n}\n\nexport class FargateToStepfunctions extends Construct {\n  public readonly vpc: ec2.IVpc;\n  public readonly service: ecs.FargateService;\n  public readonly container: ecs.ContainerDefinition;\n  public readonly stateMachine: sfn.StateMachine;\n  public readonly stateMachineLogGroup: logs.ILogGroup;\n  public readonly cloudwatchAlarms?: cloudwatch.Alarm[];\n\n  constructor(scope: Construct, id: string, props: FargateToStepfunctionsProps) {\n    super(scope, id);\n    defaults.CheckFargateProps(props);\n    defaults.CheckVpcProps(props);\n    defaults.CheckStateMachineProps(props);\n\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    defaults.AddAwsServiceEndpoint(scope, this.vpc, defaults.ServiceEndpointTypes.STEP_FUNCTIONS);\n\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    const buildStateMachineResponse = defaults.buildStateMachine(this, defaults.idPlaceholder, {\n      stateMachineProps: props.stateMachineProps,\n      logGroupProps: props.logGroupProps,\n      createCloudWatchAlarms: props.createCloudWatchAlarms,\n    });\n    this.stateMachine = buildStateMachineResponse.stateMachine;\n    this.stateMachineLogGroup = buildStateMachineResponse.logGroup;\n    this.cloudwatchAlarms = buildStateMachineResponse.cloudWatchAlarms;\n\n    this.stateMachine.grantStartExecution(this.service.taskDefinition.taskRole);\n\n    // Add environment variable\n    const stateMachineEnvironmentVariableName = props.stateMachineEnvironmentVariableName || 'STATE_MACHINE_ARN';\n    this.container.addEnvironment(stateMachineEnvironmentVariableName, this.stateMachine.stateMachineArn);\n  }\n}\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aws-solutions-constructs/aws-fargate-stepfunctions",
3
- "version": "2.85.1",
3
+ "version": "2.85.3",
4
4
  "description": "CDK Constructs for AWS Fargate to Amazon Step Functions integration",
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.1",
58
+ "@aws-solutions-constructs/core": "2.85.3",
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.1",
82
+ "@aws-solutions-constructs/core": "2.85.3",
82
83
  "constructs": "^10.0.0",
83
84
  "aws-cdk-lib": "^2.193.0"
84
85
  },