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

package/.jsii

@@ -8,7 +8,7 @@
     "url": "https://aws.amazon.com"
   },
   "dependencies": {
-    "@aws-solutions-constructs/core": "2.85.2",
+    "@aws-solutions-constructs/core": "2.85.4",
     "aws-cdk-lib": "^2.193.0",
     "constructs": "^10.0.0"
   },
@@ -3993,7 +3993,7 @@
   },
   "name": "@aws-solutions-constructs/aws-fargate-opensearch",
   "readme": {
-    "markdown": "# aws-fargate-opensearch 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_opensearch`|\n|![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-fargate-opensearch`|\n|![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.fargateopensearch`|\n\n## Overview\nThis AWS Solutions Construct implements an AWS Fargate service that can write/read to an Amazon OpenSearch Service domain.\n\nHere is a minimal deployable pattern definition:\n\nTypescript\n``` typescript\nimport { Construct } from 'constructs';\nimport { Stack, StackProps } from 'aws-cdk-lib';\nimport { FargateToOpenSearch, FargateToOpenSearchProps } from '@aws-solutions-constructs/aws-fargate-opensearch';\n\nconst constructProps: FargateToOpenSearchProps = {\n  publicApi: true,\n  ecrRepositoryArn: \"arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo\",\n  openSearchDomainName: 'testdomain',\n  // TODO: Ensure the Cognito domain name is globally unique\n  cognitoDomainName: 'globallyuniquedomain' + Aws.ACCOUNT_ID\n};\n\nnew FargateToOpenSearch(this, 'test-construct', constructProps);\n```\n\nPython\n``` python\nfrom aws_solutions_constructs.aws_fargate_opensearch import FargateToOpenSearch, FargateToOpenSearchProps\nfrom aws_cdk import (\n    Stack\n)\nfrom constructs import Construct\n\nFargateToOpenSearch(self, 'test_construct',\n            public_api=True,\n            ecr_repository_arn=\"arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo\",\n            open_search_domain_name='testdomain',\n            # TODO: Ensure the Cognito domain name is globally unique\n            cognito_domain_name='globallyuniquedomain' + Aws.ACCOUNT_ID)\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.fargateopensearch.*;\n\nnew FargateToOpenSearch(this, \"test_construct\", new FargateToOpenSearchProps.Builder()\n        .publicApi(true)\n        .ecrRepositoryArn(\"arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo\"\n        .openSearchDomainName(\"testdomain\")\n        // TODO: Ensure the Cognito domain name is globally unique\n        .cognitoDomainName(\"globallyuniquedomain\" + Aws.ACCOUNT_ID)\n        .build());\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|openSearchDomainProps?|[`opensearchservice.CfnDomainProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_opensearchservice.CfnDomainProps.html)|Optional user provided props to override the default props for the OpenSearch Service.|\n|openSearchDomainName|`string`|Domain name for the OpenSearch Service.|\n|cognitoDomainName?|`string`|Optional Amazon Cognito domain name. If omitted the Amazon Cognito domain will default to the OpenSearch Service domain name.|\n|createCloudWatchAlarms?|`boolean`|Whether to create the recommended CloudWatch alarms.|\n|domainEndpointEnvironmentVariableName?|`string`|Optional name for the OpenSearch Service domain endpoint environment variable set for the Lambda function. Default is `DOMAIN_ENDPOINT`.|\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|userPool|[`cognito.UserPool`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.UserPool.html)|Returns an instance of `cognito.UserPool` created by the construct.|\n|userPoolClient|[`cognito.UserPoolClient`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.UserPoolClient.html)|Returns an instance of `cognito.UserPoolClient` created by the construct.|\n|identityPool|[`cognito.CfnIdentityPool`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnIdentityPool.html)|Returns an instance of `cognito.CfnIdentityPool` created by the construct.|\n|openSearchDomain|[`opensearchservice.CfnDomain`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_opensearchservice.CfnDomain.html)|Returns an instance of `opensearch.CfnDomain` created by the construct.|\n|openSearchRole|[`iam.Role`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html)|Returns an instance of `iam.Role` created by the construct for `opensearch.CfnDomain`.|\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 environment variables to the container with the OpenSearch Service domain endpoint\n  * Add permissions to the container IAM role allowing it to write/read to the OpenSearch Service domain endpoint\n\n### Amazon Cognito\n* Set password policy for User Pools\n* Enforce the advanced security mode for User Pools\n\n### Amazon OpenSearch Service\n* Deploy best practices CloudWatch Alarms for the OpenSearch Service domain\n* Secure the OpenSearch Service dashboard access with Cognito User Pools\n* Enable server-side encryption for OpenSearch Service domain using AWS managed KMS Key\n* Enable node-to-node encryption for the OpenSearch Service domain\n* Configure the cluster for the OpenSearch Service domain\n\n## Architecture\n![Architecture Diagram](architecture.png)\n\n***\n&copy; Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n"
+    "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-opensearch/README.adoc)\n"
   },
   "repository": {
     "directory": "source/patterns/@aws-solutions-constructs/aws-fargate-opensearch",
@@ -4445,6 +4445,6 @@
       "symbolId": "lib/index:FargateToOpenSearchProps"
     }
   },
-  "version": "2.85.2",
-  "fingerprint": "V0LmSW/yPE+D1iWVSB6BXwllCzy/Y0N1IOv/oSO8t+4="
+  "version": "2.85.4",
+  "fingerprint": "NOVArjlV3IOKrRnaSNifpiqH4+R+ohDux/w++92CCSc="
 }

package/README.adoc

@@ -0,0 +1,279 @@
+//!!NODE_ROOT <section>
+//== aws-fargate-opensearch module
+
+[.topic]
+= aws-fargate-opensearch
+:info_doctype: section
+:info_title: aws-fargate-opensearch
+
+
+image:https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge[Stability:Experimental]
+
+____
+All classes are under active development and subject to non-backward
+compatible changes or removal in any future version. These are not
+subject to the https://semver.org/[Semantic Versioning] model. 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.
+____
+
+[width="100%",cols="<50%,<50%",options="header",]
+|===
+|*Reference Documentation*:
+|https://docs.aws.amazon.com/solutions/latest/constructs/
+|===
+
+[width="100%",cols="<46%,54%",options="header",]
+|===
+|*Language* |*Package*
+|image:https://docs.aws.amazon.com/cdk/api/latest/img/python32.png[Python
+Logo] Python
+|`aws_solutions_constructs.aws_fargate_opensearch`
+
+|image:https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png[Typescript
+Logo] Typescript |`@aws-solutions-constructs/aws-fargate-opensearch`
+
+|image:https://docs.aws.amazon.com/cdk/api/latest/img/java32.png[Java
+Logo] Java |`software.amazon.awsconstructs.services.fargateopensearch`
+|===
+
+== Overview
+
+This AWS Solutions Construct implements an AWS Fargate service that can
+write/read to an Amazon OpenSearch Service domain.
+
+Here is a minimal deployable pattern definition:
+
+====
+[role="tablist"]
+Typescript::
++
+[source,typescript]
+----
+import { Construct } from 'constructs';
+import { Stack, StackProps } from 'aws-cdk-lib';
+import { FargateToOpenSearch, FargateToOpenSearchProps } from '@aws-solutions-constructs/aws-fargate-opensearch';
+
+const constructProps: FargateToOpenSearchProps = {
+  publicApi: true,
+  ecrRepositoryArn: "arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo",
+  openSearchDomainName: 'testdomain',
+  // NOTE: Ensure the Cognito domain name is globally unique
+  cognitoDomainName: 'globallyuniquedomain' + Aws.ACCOUNT_ID
+};
+
+new FargateToOpenSearch(this, 'test-construct', constructProps);
+----
+
+Python::
++
+[source,python]
+----
+from aws_solutions_constructs.aws_fargate_opensearch import FargateToOpenSearch, FargateToOpenSearchProps
+from aws_cdk import (
+    Stack
+)
+from constructs import Construct
+
+FargateToOpenSearch(self, 'test_construct',
+            public_api=True,
+            ecr_repository_arn="arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo",
+            open_search_domain_name='testdomain',
+            # NOTE: Ensure the Cognito domain name is globally unique
+            cognito_domain_name='globallyuniquedomain' + Aws.ACCOUNT_ID)
+----
+
+Java::
++
+[source,java]
+----
+import software.constructs.Construct;
+
+import software.amazon.awscdk.Stack;
+import software.amazon.awscdk.StackProps;
+import software.amazon.awsconstructs.services.fargateopensearch.*;
+
+new FargateToOpenSearch(this, "test_construct", new FargateToOpenSearchProps.Builder()
+        .publicApi(true)
+        .ecrRepositoryArn("arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo"
+        .openSearchDomainName("testdomain")
+        // NOTE: Ensure the Cognito domain name is globally unique
+        .cognitoDomainName("globallyuniquedomain" + Aws.ACCOUNT_ID)
+        .build());
+----
+====
+
+== Pattern Construct Props
+
+[width="100%",cols="<30%,<35%,35%",options="header",]
+|===
+|*Name* |*Type* |*Description*
+|publicApi |`boolean` |Whether the construct is deploying a private or
+public API. This has implications for the VPC.
+
+|vpcProps?
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.VpcProps.html[`ec2.VpcProps`]
+|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.
+
+|existingVpc?
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html[`ec2.IVpc`]
+|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.
+
+|clusterProps?
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ClusterProps.html[`ecs.ClusterProps`]
+|Optional properties to create a new ECS cluster. To provide an existing
+cluster, use the cluster attribute of fargateServiceProps.
+
+|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_
+
+|ecrImageVersion? |`string` |The version of the image to use from the
+repository. Defaults to '`Latest`'.
+
+|containerDefinitionProps?
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ContainerDefinitionProps.html[`ecs.ContainerDefinitionProps`] {vbar} any
+|Optional props to define the container created for the Fargate Service
+(defaults found in fargate-defaults.ts).
+
+|fargateTaskDefinitionProps?
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateTaskDefinitionProps.html[`ecs.FargateTaskDefinitionProps`] {vbar} any
+|Optional props to define the Fargate Task Definition for this construct
+(defaults found in fargate-defaults.ts).
+
+|fargateServiceProps?
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateServiceProps.html[`ecs.FargateServiceProps`] {vbar} any
+|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.
+
+|existingFargateServiceObject?
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateService.html[`ecs.FargateService`]
+|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.
+
+|existingContainerDefinitionObject?
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ContainerDefinition.html[`ecs.ContainerDefinition`]
+|A container definition already instantiated as part of a Fargate
+service. This must be the container in the existingFargateServiceObject.
+
+|openSearchDomainProps?
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_opensearchservice.CfnDomainProps.html[`opensearchservice.CfnDomainProps`]
+|Optional user provided props to override the default props for the
+OpenSearch Service.
+
+|openSearchDomainName |`string` |Domain name for the OpenSearch Service.
+
+|cognitoDomainName? |`string` |Optional Amazon Cognito domain name. If
+omitted the Amazon Cognito domain will default to the OpenSearch Service
+domain name.
+
+|createCloudWatchAlarms? |`boolean` |Whether to create the recommended
+CloudWatch alarms.
+
+|domainEndpointEnvironmentVariableName? |`string` |Optional name for the
+OpenSearch Service domain endpoint environment variable set for the
+Lambda function. Default is `DOMAIN_ENDPOINT`.
+|===
+
+== Pattern Properties
+
+[width="100%",cols="<30%,<35%,35%",options="header",]
+|===
+|*Name* |*Type* |*Description*
+|vpc
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html[`ec2.IVpc`]
+|The VPC used by the construct (whether created by the construct or
+provided by the client).
+
+|service
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateService.html[`ecs.FargateService`]
+|The AWS Fargate service used by this construct (whether created by this
+construct or passed to this construct at initialization).
+
+|container
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ContainerDefinition.html[`ecs.ContainerDefinition`]
+|The container associated with the AWS Fargate service in the service
+property.
+
+|userPool
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.UserPool.html[`cognito.UserPool`]
+|Returns an instance of `cognito.UserPool` created by the construct.
+
+|userPoolClient
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.UserPoolClient.html[`cognito.UserPoolClient`]
+|Returns an instance of `cognito.UserPoolClient` created by the
+construct.
+
+|identityPool
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnIdentityPool.html[`cognito.CfnIdentityPool`]
+|Returns an instance of `cognito.CfnIdentityPool` created by the
+construct.
+
+|openSearchDomain
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_opensearchservice.CfnDomain.html[`opensearchservice.CfnDomain`]
+|Returns an instance of `opensearch.CfnDomain` created by the construct.
+
+|openSearchRole
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html[`iam.Role`]
+|Returns an instance of `iam.Role` created by the construct for
+`opensearch.CfnDomain`.
+
+|cloudWatchAlarms?
+|https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch.Alarm.html[`cloudwatch.Alarm[\]`]
+|Returns a list of `cloudwatch.Alarm` created by the construct.
+|===
+
+== Default settings
+
+Out of the box implementation of the Construct without any override will
+set the following defaults:
+
+=== AWS Fargate Service
+
+* Sets up an AWS Fargate service
+** Uses the existing service if provided
+** Creates a new service if none provided
+*** Service will run in isolated subnets if available, then private
+subnets if available and finally public subnets
+** Adds environment variables to the container with the OpenSearch
+Service domain endpoint
+** Add permissions to the container IAM role allowing it to write/read
+to the OpenSearch Service domain endpoint
+
+=== Amazon Cognito
+
+* Set password policy for User Pools
+* Enforce the advanced security mode for User Pools
+
+=== Amazon OpenSearch Service
+
+* Deploy best practices CloudWatch Alarms for the OpenSearch Service
+domain
+* Secure the OpenSearch Service dashboard access with Cognito User Pools
+* Enable server-side encryption for OpenSearch Service domain using AWS
+managed KMS Key
+* Enable node-to-node encryption for the OpenSearch Service domain
+* Configure the cluster for the OpenSearch Service domain
+
+== Architecture
+
+
+image::aws-fargate-opensearch.png["Diagram showing the Fargate service, OpenSearch domain, Cognito domain and IAM role created by the construct",scaledwidth=100%]
+
+// github block
+
+'''''
+
+© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

package/README.md

@@ -1,141 +1 @@
-# aws-fargate-opensearch module
-<!--BEGIN STABILITY BANNER-->
-
----
-
-![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge)
-
-> All classes are under active development and subject to non-backward compatible changes or removal in any
-> future version. These are not subject to the [Semantic Versioning](https://semver.org/) model.
-> 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.
-
----
-<!--END STABILITY BANNER-->
-
-| **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|
-|:-------------|:-------------|
-<div style="height:8px"></div>
-
-| **Language**     | **Package**        |
-|:-------------|-----------------|
-|![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python|`aws_solutions_constructs.aws_fargate_opensearch`|
-|![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-fargate-opensearch`|
-|![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.fargateopensearch`|
-
-## Overview
-This AWS Solutions Construct implements an AWS Fargate service that can write/read to an Amazon OpenSearch Service domain.
-
-Here is a minimal deployable pattern definition:
-
-Typescript
-``` typescript
-import { Construct } from 'constructs';
-import { Stack, StackProps } from 'aws-cdk-lib';
-import { FargateToOpenSearch, FargateToOpenSearchProps } from '@aws-solutions-constructs/aws-fargate-opensearch';
-
-const constructProps: FargateToOpenSearchProps = {
-  publicApi: true,
-  ecrRepositoryArn: "arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo",
-  openSearchDomainName: 'testdomain',
-  // TODO: Ensure the Cognito domain name is globally unique
-  cognitoDomainName: 'globallyuniquedomain' + Aws.ACCOUNT_ID
-};
-
-new FargateToOpenSearch(this, 'test-construct', constructProps);
-```
-
-Python
-``` python
-from aws_solutions_constructs.aws_fargate_opensearch import FargateToOpenSearch, FargateToOpenSearchProps
-from aws_cdk import (
-    Stack
-)
-from constructs import Construct
-
-FargateToOpenSearch(self, 'test_construct',
-            public_api=True,
-            ecr_repository_arn="arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo",
-            open_search_domain_name='testdomain',
-            # TODO: Ensure the Cognito domain name is globally unique
-            cognito_domain_name='globallyuniquedomain' + Aws.ACCOUNT_ID)
-```
-
-Java
-``` java
-import software.constructs.Construct;
-
-import software.amazon.awscdk.Stack;
-import software.amazon.awscdk.StackProps;
-import software.amazon.awsconstructs.services.fargateopensearch.*;
-
-new FargateToOpenSearch(this, "test_construct", new FargateToOpenSearchProps.Builder()
-        .publicApi(true)
-        .ecrRepositoryArn("arn:aws:ecr:us-east-1:123456789012:repository/your-ecr-repo"
-        .openSearchDomainName("testdomain")
-        // TODO: Ensure the Cognito domain name is globally unique
-        .cognitoDomainName("globallyuniquedomain" + Aws.ACCOUNT_ID)
-        .build());
-```
-## Pattern Construct Props
-
-| **Name**     | **Type**        | **Description** |
-|:-------------|:----------------|-----------------|
-| publicApi | `boolean` | Whether the construct is deploying a private or public API. This has implications for the VPC. |
-| 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. |
-| 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. |
-| 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. |
-| 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* |
-| ecrImageVersion? | `string` | The version of the image to use from the repository. Defaults to 'Latest'. |
-| 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). |
-| 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). |
-| 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. |
-| 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.|
-| 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.|
-|openSearchDomainProps?|[`opensearchservice.CfnDomainProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_opensearchservice.CfnDomainProps.html)|Optional user provided props to override the default props for the OpenSearch Service.|
-|openSearchDomainName|`string`|Domain name for the OpenSearch Service.|
-|cognitoDomainName?|`string`|Optional Amazon Cognito domain name. If omitted the Amazon Cognito domain will default to the OpenSearch Service domain name.|
-|createCloudWatchAlarms?|`boolean`|Whether to create the recommended CloudWatch alarms.|
-|domainEndpointEnvironmentVariableName?|`string`|Optional name for the OpenSearch Service domain endpoint environment variable set for the Lambda function. Default is `DOMAIN_ENDPOINT`.|
-
-## Pattern Properties
-
-| **Name**     | **Type**        | **Description** |
-|:-------------|:----------------|-----------------|
-| 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). |
-| 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). |
-| 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. |
-|userPool|[`cognito.UserPool`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.UserPool.html)|Returns an instance of `cognito.UserPool` created by the construct.|
-|userPoolClient|[`cognito.UserPoolClient`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.UserPoolClient.html)|Returns an instance of `cognito.UserPoolClient` created by the construct.|
-|identityPool|[`cognito.CfnIdentityPool`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.CfnIdentityPool.html)|Returns an instance of `cognito.CfnIdentityPool` created by the construct.|
-|openSearchDomain|[`opensearchservice.CfnDomain`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_opensearchservice.CfnDomain.html)|Returns an instance of `opensearch.CfnDomain` created by the construct.|
-|openSearchRole|[`iam.Role`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html)|Returns an instance of `iam.Role` created by the construct for `opensearch.CfnDomain`.|
-|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.|
-
-## Default settings
-
-Out of the box implementation of the Construct without any override will set the following defaults:
-
-### AWS Fargate Service
-* Sets up an AWS Fargate service
-  * Uses the existing service if provided
-  * Creates a new service if none provided
-    * Service will run in isolated subnets if available, then private subnets if available and finally public subnets
-  * Adds environment variables to the container with the OpenSearch Service domain endpoint
-  * Add permissions to the container IAM role allowing it to write/read to the OpenSearch Service domain endpoint
-
-### Amazon Cognito
-* Set password policy for User Pools
-* Enforce the advanced security mode for User Pools
-
-### Amazon OpenSearch Service
-* Deploy best practices CloudWatch Alarms for the OpenSearch Service domain
-* Secure the OpenSearch Service dashboard access with Cognito User Pools
-* Enable server-side encryption for OpenSearch Service domain using AWS managed KMS Key
-* Enable node-to-node encryption for the OpenSearch Service domain
-* Configure the cluster for the OpenSearch Service domain
-
-## Architecture
-![Architecture Diagram](architecture.png)
-
-***
-&copy; Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+Documentation for this pattern can be found [here](https://github.com/awslabs/aws-solutions-constructs/blob/main/source/patterns/%40aws-solutions-constructs/aws-fargate-opensearch/README.adoc)

package/lib/index.js

@@ -77,5 +77,5 @@ class FargateToOpenSearch extends constructs_1.Construct {
 }
 exports.FargateToOpenSearch = FargateToOpenSearch;
 _a = JSII_RTTI_SYMBOL_1;
-FargateToOpenSearch[_a] = { fqn: "@aws-solutions-constructs/aws-fargate-opensearch.FargateToOpenSearch", version: "2.85.2" };
+FargateToOpenSearch[_a] = { fqn: "@aws-solutions-constructs/aws-fargate-opensearch.FargateToOpenSearch", version: "2.85.4" };
 //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;;;AAAA;;;;;;;;;;;GAWG;AAEH,2DAA2D;AAO3D,wFAAwF;AACxF,2CAAuC;AAiHvC,MAAa,mBAAoB,SAAQ,sBAAS;IAWhD,YAAY,KAAgB,EAAE,EAAU,EAAE,KAA+B;QACvE,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,oBAAoB,CAAC,KAAK,CAAC,CAAC;QAErC,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,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,IAAI,qBAA+B,CAAC;QAEpC,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,YAAY,EAAE,qBAAqB,CAAC;YAC5E,QAAQ,CAAC,4BAA4B,CAAC,IAAI,EAAE,KAAK,CAAC,iBAAiB,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;QAErG,IAAI,gBAAgB,CAAC;QAErB,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;YACb,gBAAgB,GAAG,QAAQ,CAAC,6BAA6B,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1E,CAAC;QAED,MAAM,oBAAoB,GAAkC;YAC1D,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,wBAAwB,EAAE,qBAAqB,CAAC,OAAO;YACvD,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,oBAAoB,EAAE,KAAK,CAAC,oBAAoB;YAChD,iBAAiB,EAAE,KAAK,CAAC,qBAAqB;YAC9C,gBAAgB;SACjB,CAAC;QAEF,MAAM,uBAAuB,GAAG,QAAQ,CAAC,eAAe,CAAC,IAAI,EAAE,oBAAoB,CAAC,CAAC;QACrF,IAAI,CAAC,gBAAgB,GAAG,uBAAuB,CAAC,MAAM,CAAC;QACvD,IAAI,CAAC,cAAc,GAAG,uBAAuB,CAAC,IAAI,CAAC;QAEnD,IAAI,KAAK,CAAC,sBAAsB,KAAK,SAAS,IAAI,KAAK,CAAC,sBAAsB,EAAE,CAAC;YAC/E,IAAI,CAAC,gBAAgB,GAAG,QAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;QACjE,CAAC;QAED,4BAA4B;QAC5B,MAAM,qCAAqC,GAAG,KAAK,CAAC,qCAAqC,IAAI,iBAAiB,CAAC;QAC/G,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,qCAAqC,EAAE,IAAI,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,CAAC;IAEjH,CAAC;;AA3EH,kDA4EC","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\nimport * as defaults from \"@aws-solutions-constructs/core\";\nimport * as ecs from \"aws-cdk-lib/aws-ecs\";\nimport * as iam from \"aws-cdk-lib/aws-iam\";\nimport * as cognito from 'aws-cdk-lib/aws-cognito';\nimport * as ec2 from \"aws-cdk-lib/aws-ec2\";\nimport * as cloudwatch from 'aws-cdk-lib/aws-cloudwatch';\nimport * as opensearch from \"aws-cdk-lib/aws-opensearchservice\";\n// Note: To ensure CDKv2 compatibility, keep the import statement for Construct separate\nimport { Construct } from \"constructs\";\n\nexport interface FargateToOpenSearchProps {\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.\n   *\n   * @default - none\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.\n   *\n   * @default - none\n   */\n  readonly existingVpc?: ec2.IVpc;\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 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   * Optional user provided props to override the default props for the OpenSearch Service.\n   *\n   * @default - Default props are used\n   */\n  readonly openSearchDomainProps?: opensearch.CfnDomainProps;\n  /**\n   * Domain name for the OpenSearch Service.\n   *\n   * @default - None\n   */\n  readonly openSearchDomainName: string;\n  /**\n   * Optional Amazon Cognito domain name. If omitted the Amazon Cognito domain will default to the OpenSearch Service domain name.\n   *\n   * @default - the OpenSearch Service domain name\n   */\n  readonly cognitoDomainName?: string;\n  /**\n   * Whether to create recommended CloudWatch alarms\n   *\n   * @default - Alarms are created\n   */\n  readonly createCloudWatchAlarms?: boolean;\n  /**\n   * Optional Name for the container environment variable set to the domain endpoint.\n   *\n   * @default - DOMAIN_ENDPOINT\n   */\n  readonly domainEndpointEnvironmentVariableName?: string;\n}\n\nexport class FargateToOpenSearch extends Construct {\n  public readonly vpc: ec2.IVpc;\n  public readonly service: ecs.FargateService;\n  public readonly container: ecs.ContainerDefinition;\n  public readonly userPool: cognito.UserPool;\n  public readonly userPoolClient: cognito.UserPoolClient;\n  public readonly identityPool: cognito.CfnIdentityPool;\n  public readonly openSearchDomain: opensearch.CfnDomain;\n  public readonly openSearchRole: iam.Role;\n  public readonly cloudWatchAlarms?: cloudwatch.Alarm[];\n\n  constructor(scope: Construct, id: string, props: FargateToOpenSearchProps) {\n    super(scope, id);\n    defaults.CheckFargateProps(props);\n    defaults.CheckVpcProps(props);\n    defaults.CheckOpenSearchProps(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    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    let cognitoAuthorizedRole: iam.Role;\n\n    [this.userPool, this.userPoolClient, this.identityPool, cognitoAuthorizedRole] =\n      defaults.buildCognitoForSearchService(this, props.cognitoDomainName ?? props.openSearchDomainName);\n\n    let securityGroupIds;\n\n    if (this.vpc) {\n      securityGroupIds = defaults.getServiceVpcSecurityGroupIds(this.service);\n    }\n\n    const buildOpenSearchProps: defaults.BuildOpenSearchProps = {\n      userpool: this.userPool,\n      identitypool: this.identityPool,\n      cognitoAuthorizedRoleARN: cognitoAuthorizedRole.roleArn,\n      vpc: this.vpc,\n      openSearchDomainName: props.openSearchDomainName,\n      clientDomainProps: props.openSearchDomainProps,\n      securityGroupIds\n    };\n\n    const buildOpenSearchResponse = defaults.buildOpenSearch(this, buildOpenSearchProps);\n    this.openSearchDomain = buildOpenSearchResponse.domain;\n    this.openSearchRole = buildOpenSearchResponse.role;\n\n    if (props.createCloudWatchAlarms === undefined || props.createCloudWatchAlarms) {\n      this.cloudWatchAlarms = defaults.buildOpenSearchCWAlarms(this);\n    }\n\n    // Add environment variables\n    const domainEndpointEnvironmentVariableName = props.domainEndpointEnvironmentVariableName || 'DOMAIN_ENDPOINT';\n    this.container.addEnvironment(domainEndpointEnvironmentVariableName, this.openSearchDomain.attrDomainEndpoint);\n\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-solutions-constructs/aws-fargate-opensearch",
-  "version": "2.85.2",
+  "version": "2.85.4",
   "description": "CDK Constructs for AWS Fargate to Amazon OpenSearch Service",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -22,12 +22,13 @@
     "test": "jest --coverage",
     "clean": "tsc -b --clean",
     "watch": "tsc -b -w",
+    "asciidoc": "asciidoctor --failure-level WARNING -o /dev/null README.adoc",
     "integ": "integ-runner --update-on-failed",
     "integ-no-clean": "integ-runner --update-on-failed --no-clean",
     "integ-assert": "integ-runner",
     "jsii": "jsii",
     "jsii-pacmak": "jsii-pacmak",
-    "build+lint+test": "npm run jsii && npm run lint && npm test && npm run integ-assert",
+    "build+lint+test": "npm run jsii && npm run lint && npm run asciidoc && npm test && npm run integ-assert",
     "blt": "npm run build+lint+test",
     "snapshot-update": "npm run jsii && npm test -- -u && npm run integ-assert"
   },
@@ -54,7 +55,7 @@
     }
   },
   "dependencies": {
-    "@aws-solutions-constructs/core": "2.85.2",
+    "@aws-solutions-constructs/core": "2.85.4",
     "constructs": "^10.0.0"
   },
   "devDependencies": {
@@ -78,7 +79,7 @@
     ]
   },
   "peerDependencies": {
-    "@aws-solutions-constructs/core": "2.85.2",
+    "@aws-solutions-constructs/core": "2.85.4",
     "constructs": "^10.0.0",
     "aws-cdk-lib": "^2.193.0"
   },