feat(opensearchservice): support for MultiAZWithStandBy (under featur…

…e flag) (#26082) This fix adds support for the [`MultiAZWithStandbyEnabled`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html#:~:text=%3A%20No%20interruption-,MultiAZWithStandbyEnabled,Update%20requires%3A%20No%20interruption,-WarmCount) flag to the [`CapacityConfig`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_opensearchservice.CapacityConfig.html) interface. If enabled, the `ENABLE_OPENSEARCH_MULTIAZ_WITH_STANDBY` feature flag set the default value of `MultiAZWithStandbyEnabled` to `true` Closes #26026. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
aws · Jul 17, 2023 · 6c75581 · 6c75581
1 parent 9381880
commit 6c75581
Show file tree

Hide file tree

Showing 32 changed files with 604 additions and 11 deletions.
diff --git a/...st/aws-appsync/test/integ.graphql-opensearch.js.snapshot/appsync-opensearch.template.json b/...st/aws-appsync/test/integ.graphql-opensearch.js.snapshot/appsync-opensearch.template.json
@@ -22,7 +22,8 @@
      "DedicatedMasterEnabled": false,
      "InstanceCount": 1,
      "InstanceType": "r5.large.search",
-     "ZoneAwarenessEnabled": false
+     "ZoneAwarenessEnabled": false,
+     "MultiAZWithStandbyEnabled": false
     },
     "DomainEndpointOptions": {
      "EnforceHTTPS": true,

diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-appsync/test/integ.graphql-opensearch.ts b/packages/@aws-cdk-testing/framework-integ/test/aws-appsync/test/integ.graphql-opensearch.ts
@@ -23,6 +23,9 @@ class OpensSearch23Stack extends cdk.Stack {
       },
       nodeToNodeEncryption: true,
       enforceHttps: true,
+      capacity: {
+        multiAzWithStandbyEnabled: false,
+      },
     });
 
     const api = new appsync.GraphqlApi(this, 'api', {

diff --git a/...ensearch.advancedsecurity.js.snapshot/cdk-integ-opensearch-advancedsecurity.template.json b/...ensearch.advancedsecurity.js.snapshot/cdk-integ-opensearch-advancedsecurity.template.json
@@ -22,7 +22,8 @@
      "DedicatedMasterEnabled": false,
      "InstanceCount": 1,
      "InstanceType": "r5.large.search",
-     "ZoneAwarenessEnabled": false
+     "ZoneAwarenessEnabled": false,
+     "MultiAZWithStandbyEnabled": false
     },
     "DomainEndpointOptions": {
      "EnforceHTTPS": true,

diff --git a/...ting/framework-integ/test/aws-opensearchservice/test/integ.opensearch.advancedsecurity.ts b/...ting/framework-integ/test/aws-opensearchservice/test/integ.opensearch.advancedsecurity.ts
@@ -20,6 +20,9 @@ class TestStack extends Stack {
       },
       nodeToNodeEncryption: true,
       enforceHttps: true,
+      capacity: {
+        multiAzWithStandbyEnabled: false,
+      },
     });
   }
 }

diff --git a/...ognitodashboardsauth.js.snapshot/cdk-integ-opensearch-cognitodashboardsauth.template.json b/...ognitodashboardsauth.js.snapshot/cdk-integ-opensearch-cognitodashboardsauth.template.json
@@ -84,7 +84,8 @@
      "DedicatedMasterEnabled": false,
      "InstanceCount": 1,
      "InstanceType": "r5.large.search",
-     "ZoneAwarenessEnabled": false
+     "ZoneAwarenessEnabled": false,
+     "MultiAZWithStandbyEnabled": false
     },
     "CognitoOptions": {
      "Enabled": true,

diff --git a/...framework-integ/test/aws-opensearchservice/test/integ.opensearch.cognitodashboardsauth.ts b/...framework-integ/test/aws-opensearchservice/test/integ.opensearch.cognitodashboardsauth.ts
@@ -39,6 +39,9 @@ class TestStack extends Stack {
         identityPoolId: identityPool.ref,
         userPoolId: userPool.userPoolId,
       },
+      capacity: {
+        multiAzWithStandbyEnabled: false,
+      },
     });
   }
 }

diff --git a/...g.opensearch.custom-kms-key.js.snapshot/cdk-integ-opensearch-custom-kms-key.template.json b/...g.opensearch.custom-kms-key.js.snapshot/cdk-integ-opensearch-custom-kms-key.template.json
@@ -42,7 +42,8 @@
      "DedicatedMasterEnabled": false,
      "InstanceCount": 1,
      "InstanceType": "r5.large.search",
-     "ZoneAwarenessEnabled": false
+     "ZoneAwarenessEnabled": false,
+     "MultiAZWithStandbyEnabled": false
     },
     "DomainEndpointOptions": {
      "EnforceHTTPS": false,

diff --git a/...esting/framework-integ/test/aws-opensearchservice/test/integ.opensearch.custom-kms-key.ts b/...esting/framework-integ/test/aws-opensearchservice/test/integ.opensearch.custom-kms-key.ts
@@ -26,6 +26,9 @@ class TestStack extends Stack {
           resources: ['*'],
         }),
       ],
+      capacity: {
+        multiAzWithStandbyEnabled: false,
+      },
     };
 
     new opensearch.Domain(this, 'Domain', domainProps);

diff --git a/...ws-opensearchservice/test/integ.opensearch.js.snapshot/cdk-integ-opensearch.template.json b/...ws-opensearchservice/test/integ.opensearch.js.snapshot/cdk-integ-opensearch.template.json
@@ -114,7 +114,8 @@
      "DedicatedMasterEnabled": false,
      "InstanceCount": 1,
      "InstanceType": "r5.large.search",
-     "ZoneAwarenessEnabled": false
+     "ZoneAwarenessEnabled": false,
+     "MultiAZWithStandbyEnabled": false
     },
     "DomainEndpointOptions": {
      "EnforceHTTPS": false,
@@ -419,7 +420,8 @@
      "DedicatedMasterEnabled": false,
      "InstanceCount": 1,
      "InstanceType": "r5.large.search",
-     "ZoneAwarenessEnabled": false
+     "ZoneAwarenessEnabled": false,
+     "MultiAZWithStandbyEnabled": false
     },
     "DomainEndpointOptions": {
      "EnforceHTTPS": false,

diff --git a/...pensearchservice/test/integ.opensearch.min.js.snapshot/cdk-integ-opensearch.template.json b/...pensearchservice/test/integ.opensearch.min.js.snapshot/cdk-integ-opensearch.template.json
@@ -7,7 +7,8 @@
      "DedicatedMasterEnabled": false,
      "InstanceCount": 1,
      "InstanceType": "r5.large.search",
-     "ZoneAwarenessEnabled": false
+     "ZoneAwarenessEnabled": false,
+     "MultiAZWithStandbyEnabled": false
     },
     "DomainEndpointOptions": {
      "EnforceHTTPS": false,

diff --git a/.../@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.min.ts b/.../@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.min.ts
@@ -11,6 +11,9 @@ class TestStack extends Stack {
     const domainProps: opensearch.DomainProps = {
       version: opensearch.EngineVersion.OPENSEARCH_2_7,
       removalPolicy: RemovalPolicy.DESTROY,
+      capacity: {
+        multiAzWithStandbyEnabled: false,
+      },
     };
 
     new opensearch.Domain(this, 'Domain', domainProps);

diff --git a/....js.snapshot/IntegOpenSearchMultiAzWithStandbyDefaultTestDeployAssertFD2E7982.assets.json b/....js.snapshot/IntegOpenSearchMultiAzWithStandbyDefaultTestDeployAssertFD2E7982.assets.json
@@ -0,0 +1,19 @@
+{
+  "version": "32.0.0",
+  "files": {
+    "21fbb51d7b23f6a6c262b46a9caee79d744a3ac019fd45422d988b96d44b2a22": {
+      "source": {
+        "path": "IntegOpenSearchMultiAzWithStandbyDefaultTestDeployAssertFD2E7982.template.json",
+        "packaging": "file"
+      },
+      "destinations": {
+        "current_account-current_region": {
+          "bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}",
+          "objectKey": "21fbb51d7b23f6a6c262b46a9caee79d744a3ac019fd45422d988b96d44b2a22.json",
+          "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}"
+        }
+      }
+    }
+  },
+  "dockerImages": {}
+}
diff --git a/...s.snapshot/IntegOpenSearchMultiAzWithStandbyDefaultTestDeployAssertFD2E7982.template.json b/...s.snapshot/IntegOpenSearchMultiAzWithStandbyDefaultTestDeployAssertFD2E7982.template.json
@@ -0,0 +1,36 @@
+{
+ "Parameters": {
+  "BootstrapVersion": {
+   "Type": "AWS::SSM::Parameter::Value<String>",
+   "Default": "/cdk-bootstrap/hnb659fds/version",
+   "Description": "Version of the CDK Bootstrap resources in this environment, automatically retrieved from SSM Parameter Store. [cdk:skip]"
+  }
+ },
+ "Rules": {
+  "CheckBootstrapVersion": {
+   "Assertions": [
+    {
+     "Assert": {
+      "Fn::Not": [
+       {
+        "Fn::Contains": [
+         [
+          "1",
+          "2",
+          "3",
+          "4",
+          "5"
+         ],
+         {
+          "Ref": "BootstrapVersion"
+         }
+        ]
+       }
+      ]
+     },
+     "AssertDescription": "CDK bootstrap stack version 6 required. Please run 'cdk bootstrap' with a recent version of the CDK CLI."
+    }
+   ]
+  }
+ }
+}
diff --git a/...ch.multiaz-with-standby.js.snapshot/cdk-integ-opensearch-multiaz-with-standby.assets.json b/...ch.multiaz-with-standby.js.snapshot/cdk-integ-opensearch-multiaz-with-standby.assets.json
@@ -0,0 +1,19 @@
+{
+  "version": "32.0.0",
+  "files": {
+    "722892555255764f20f275e929016594c8562b137bbdfb5df2a004c9565301df": {
+      "source": {
+        "path": "cdk-integ-opensearch-multiaz-with-standby.template.json",
+        "packaging": "file"
+      },
+      "destinations": {
+        "current_account-current_region": {
+          "bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}",
+          "objectKey": "722892555255764f20f275e929016594c8562b137bbdfb5df2a004c9565301df.json",
+          "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}"
+        }
+      }
+    }
+  },
+  "dockerImages": {}
+}
diff --git a/....multiaz-with-standby.js.snapshot/cdk-integ-opensearch-multiaz-with-standby.template.json b/....multiaz-with-standby.js.snapshot/cdk-integ-opensearch-multiaz-with-standby.template.json
@@ -0,0 +1,74 @@
+{
+ "Resources": {
+  "Domain66AC69E0": {
+   "Type": "AWS::OpenSearchService::Domain",
+   "Properties": {
+    "ClusterConfig": {
+     "DedicatedMasterCount": 3,
+     "DedicatedMasterEnabled": true,
+     "DedicatedMasterType": "r5.large.search",
+     "InstanceCount": 3,
+     "InstanceType": "r5.large.search",
+     "MultiAZWithStandbyEnabled": true,
+     "ZoneAwarenessConfig": {
+      "AvailabilityZoneCount": 3
+     },
+     "ZoneAwarenessEnabled": true
+    },
+    "DomainEndpointOptions": {
+     "EnforceHTTPS": false,
+     "TLSSecurityPolicy": "Policy-Min-TLS-1-0-2019-07"
+    },
+    "EBSOptions": {
+     "EBSEnabled": true,
+     "VolumeSize": 10,
+     "VolumeType": "gp3"
+    },
+    "EncryptionAtRestOptions": {
+     "Enabled": false
+    },
+    "EngineVersion": "OpenSearch_1.3",
+    "LogPublishingOptions": {},
+    "NodeToNodeEncryptionOptions": {
+     "Enabled": false
+    }
+   },
+   "UpdateReplacePolicy": "Delete",
+   "DeletionPolicy": "Delete"
+  }
+ },
+ "Parameters": {
+  "BootstrapVersion": {
+   "Type": "AWS::SSM::Parameter::Value<String>",
+   "Default": "/cdk-bootstrap/hnb659fds/version",
+   "Description": "Version of the CDK Bootstrap resources in this environment, automatically retrieved from SSM Parameter Store. [cdk:skip]"
+  }
+ },
+ "Rules": {
+  "CheckBootstrapVersion": {
+   "Assertions": [
+    {
+     "Assert": {
+      "Fn::Not": [
+       {
+        "Fn::Contains": [
+         [
+          "1",
+          "2",
+          "3",
+          "4",
+          "5"
+         ],
+         {
+          "Ref": "BootstrapVersion"
+         }
+        ]
+       }
+      ]
+     },
+     "AssertDescription": "CDK bootstrap stack version 6 required. Please run 'cdk bootstrap' with a recent version of the CDK CLI."
+    }
+   ]
+  }
+ }
+}
diff --git a/...test/aws-opensearchservice/test/integ.opensearch.multiaz-with-standby.js.snapshot/cdk.out b/...test/aws-opensearchservice/test/integ.opensearch.multiaz-with-standby.js.snapshot/cdk.out
@@ -0,0 +1 @@
+{"version":"32.0.0"}
diff --git a/...t/aws-opensearchservice/test/integ.opensearch.multiaz-with-standby.js.snapshot/integ.json b/...t/aws-opensearchservice/test/integ.opensearch.multiaz-with-standby.js.snapshot/integ.json
@@ -0,0 +1,12 @@
+{
+  "version": "32.0.0",
+  "testCases": {
+    "IntegOpenSearchMultiAzWithStandby/DefaultTest": {
+      "stacks": [
+        "cdk-integ-opensearch-multiaz-with-standby"
+      ],
+      "assertionStack": "IntegOpenSearchMultiAzWithStandby/DefaultTest/DeployAssert",
+      "assertionStackName": "IntegOpenSearchMultiAzWithStandbyDefaultTestDeployAssertFD2E7982"
+    }
+  }
+}