handled default values

aws · Jul 22, 2023 · c667e52 · c667e52
1 parent 3b24e02
commit c667e52
Show file tree

Hide file tree

Showing 11 changed files with 149 additions and 8 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
@@ -41,6 +41,15 @@
     "LogPublishingOptions": {},
     "NodeToNodeEncryptionOptions": {
      "Enabled": true
+    },
+    "OffPeakWindowOptions": {
+      "Enabled": true,
+      "OffPeakWindow": {
+        "WindowStartTime": {
+          "Hours": 0,
+          "Minutes": 0
+        }
+      }
     }
    },
    "UpdateReplacePolicy": "Delete",

diff --git a/...ensearch.advancedsecurity.js.snapshot/cdk-integ-opensearch-advancedsecurity.template.json b/...ensearch.advancedsecurity.js.snapshot/cdk-integ-opensearch-advancedsecurity.template.json
@@ -41,6 +41,15 @@
     "LogPublishingOptions": {},
     "NodeToNodeEncryptionOptions": {
      "Enabled": true
+    },
+    "OffPeakWindowOptions": {
+      "Enabled": true,
+      "OffPeakWindow": {
+        "WindowStartTime": {
+          "Hours": 0,
+          "Minutes": 0
+        }
+      }
     }
    },
    "UpdateReplacePolicy": "Delete",

diff --git a/...ognitodashboardsauth.js.snapshot/cdk-integ-opensearch-cognitodashboardsauth.template.json b/...ognitodashboardsauth.js.snapshot/cdk-integ-opensearch-cognitodashboardsauth.template.json
@@ -118,6 +118,15 @@
     "LogPublishingOptions": {},
     "NodeToNodeEncryptionOptions": {
      "Enabled": false
+    },
+    "OffPeakWindowOptions": {
+      "Enabled": true,
+      "OffPeakWindow": {
+        "WindowStartTime": {
+          "Hours": 0,
+          "Minutes": 0
+        }
+      }
     }
    },
    "UpdateReplacePolicy": "Delete",

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
@@ -64,6 +64,15 @@
     "LogPublishingOptions": {},
     "NodeToNodeEncryptionOptions": {
      "Enabled": false
+    },
+    "OffPeakWindowOptions": {
+      "Enabled": true,
+      "OffPeakWindow": {
+        "WindowStartTime": {
+          "Hours": 0,
+          "Minutes": 0
+        }
+      }
     }
    },
    "UpdateReplacePolicy": "Delete",

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
@@ -26,6 +26,15 @@
     "LogPublishingOptions": {},
     "NodeToNodeEncryptionOptions": {
      "Enabled": false
+    },
+    "OffPeakWindowOptions": {
+      "Enabled": true,
+      "OffPeakWindow": {
+        "WindowStartTime": {
+          "Hours": 0,
+          "Minutes": 0
+        }
+      }
     }
    },
    "UpdateReplacePolicy": "Delete",

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
@@ -31,6 +31,15 @@
     "LogPublishingOptions": {},
     "NodeToNodeEncryptionOptions": {
      "Enabled": false
+    },
+    "OffPeakWindowOptions": {
+      "Enabled": true,
+      "OffPeakWindow": {
+        "WindowStartTime": {
+          "Hours": 0,
+          "Minutes": 0
+        }
+      }
     }
    },
    "UpdateReplacePolicy": "Delete",

diff --git a/.../test/integ.opensearch.ultrawarm.js.snapshot/cdk-integ-opensearch-ultrawarm.template.json b/.../test/integ.opensearch.ultrawarm.js.snapshot/cdk-integ-opensearch-ultrawarm.template.json
@@ -31,6 +31,15 @@
     "LogPublishingOptions": {},
     "NodeToNodeEncryptionOptions": {
      "Enabled": false
+    },
+    "OffPeakWindowOptions": {
+      "Enabled": true,
+      "OffPeakWindow": {
+        "WindowStartTime": {
+          "Hours": 0,
+          "Minutes": 0
+        }
+      }
     }
    },
    "UpdateReplacePolicy": "Delete",

diff --git a/...search.unsignedbasicauth.js.snapshot/cdk-integ-opensearch-unsignedbasicauth.template.json b/...search.unsignedbasicauth.js.snapshot/cdk-integ-opensearch-unsignedbasicauth.template.json
@@ -57,6 +57,15 @@
     "LogPublishingOptions": {},
     "NodeToNodeEncryptionOptions": {
      "Enabled": true
+    },
+    "OffPeakWindowOptions": {
+      "Enabled": true,
+      "OffPeakWindow": {
+        "WindowStartTime": {
+          "Hours": 0,
+          "Minutes": 0
+        }
+      }
     }
    },
    "UpdateReplacePolicy": "Delete",

diff --git a/...earchservice/test/integ.opensearch.vpc.js.snapshot/cdk-integ-opensearch-vpc.template.json b/...earchservice/test/integ.opensearch.vpc.js.snapshot/cdk-integ-opensearch-vpc.template.json
@@ -464,6 +464,15 @@
        "Ref": "VpcPrivateSubnet2Subnet3788AAA1"
       }
      ]
+    },
+    "OffPeakWindowOptions": {
+      "Enabled": true,
+      "OffPeakWindow": {
+        "WindowStartTime": {
+          "Hours": 0,
+          "Minutes": 0
+        }
+      }
     }
    },
    "DependsOn": [

diff --git a/packages/aws-cdk-lib/aws-opensearchservice/lib/domain.ts b/packages/aws-cdk-lib/aws-opensearchservice/lib/domain.ts
@@ -332,10 +332,14 @@ export interface WindowStartTime {
   /**
    * The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time.
    * For example, 17 refers to 5:00 P.M. UTC.
+   *
+   * @default - 0
    */
   readonly hours: number;
   /**
    * The start minute of the window, in UTC.
+   *
+   * @default - 0
    */
   readonly minutes: number;
 }
@@ -345,21 +349,28 @@ export interface OffPeakWindow {
    * A custom start time for the off-peak window, in Coordinated Universal Time (UTC).
    * The window length will always be 10 hours, so you can't specify an end time.
    * For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.
+   *
+   * @default - 00:00 UTC
    */
   readonly windowStartTime?: WindowStartTime;
 }
 
 /**
  * Off-peak window settings for the domain.
+ * You can't disable the off-peak window for a domain after it's enabled.
  */
 export interface OffPeakWindowOptions {
   /**
    * Specifies whether off-peak window settings are enabled for the domain.
+   *
+   * @default - true
    */
   readonly enabled?: boolean;
 
   /**
    * Off-peak window settings for the domain.
+   *
+   * @default - default window start time is 00:00 UTC
    */
   readonly offPeakWindow?: OffPeakWindow;
 }
@@ -370,6 +381,8 @@ export interface OffPeakWindowOptions {
 export interface SoftwareUpdateOptions {
   /**
    * Specifies whether automatic service software updates are enabled for the domain.
+   *
+   * @default - automatic software updates are disabled
    */
   readonly autoSoftwareUpdateEnabled?: boolean;
 }
@@ -561,11 +574,15 @@ export interface DomainProps {
   /**
    * Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory
    * configuration changes on the domain.
+   *
+   * @default - off-peak window is enabled by default with 00:00 UTC start time.
    */
   readonly offPeakWindowOptions?: OffPeakWindowOptions;
 
   /**
    * Options for configuring service software updates for a domain.
+   *
+   * @default - no software updates configured for the domain
    */
   readonly softwareUpdateOptions?: SoftwareUpdateOptions;
 }
@@ -1615,7 +1632,22 @@ export class Domain extends DomainBase implements IDomain, ec2.IConnectable {
       }
     }
 
-    this.validateWindowStartTime(props.offPeakWindowOptions?.offPeakWindow?.windowStartTime);
+    let offPeakWindowOptions: OffPeakWindowOptions = {
+      enabled: props.offPeakWindowOptions?.enabled ?? true,
+    };
+    if (offPeakWindowOptions.enabled) {
+      offPeakWindowOptions = {
+        ...offPeakWindowOptions,
+        offPeakWindow: {
+          windowStartTime: {
+            hours: props.offPeakWindowOptions?.offPeakWindow?.windowStartTime?.hours ?? 0,
+            minutes: props.offPeakWindowOptions?.offPeakWindow?.windowStartTime?.minutes ?? 0,
+          },
+        },
+      };
+    }
+
+    this.validateWindowStartTime(offPeakWindowOptions?.offPeakWindow?.windowStartTime);
 
     // Create the domain
     this.domain = new CfnDomain(this, 'Resource', {
@@ -1691,12 +1723,7 @@ export class Domain extends DomainBase implements IDomain, ec2.IConnectable {
         }
         : undefined,
       advancedOptions: props.advancedOptions,
-      offPeakWindowOptions: props.offPeakWindowOptions ? {
-        enabled: props.offPeakWindowOptions.enabled,
-        offPeakWindow: props.offPeakWindowOptions.offPeakWindow && props.offPeakWindowOptions.offPeakWindow.windowStartTime ? {
-          windowStartTime: props.offPeakWindowOptions.offPeakWindow.windowStartTime,
-        } : undefined,
-      } : undefined,
+      offPeakWindowOptions: offPeakWindowOptions,
       softwareUpdateOptions: props.softwareUpdateOptions,
     });
     this.domain.applyRemovalPolicy(props.removalPolicy);

diff --git a/packages/aws-cdk-lib/aws-opensearchservice/test/domain.test.ts b/packages/aws-cdk-lib/aws-opensearchservice/test/domain.test.ts
@@ -1981,7 +1981,7 @@ each(testedOpenSearchVersions).describe('cognito dashboards auth', (engineVersio
 });
 
 each(testedOpenSearchVersions).describe('offPeakWindowOptions and softwareUpdateOptions properties', (engineVersion) => {
-  test('with offPeakWindowOptions', () => {
+  test('with offPeakWindowOptions enabled', () => {
     new Domain(stack, 'Domain', {
       version: engineVersion,
       offPeakWindowOptions: {
@@ -2008,6 +2008,39 @@ each(testedOpenSearchVersions).describe('offPeakWindowOptions and softwareUpdate
     });
   });
 
+  test('with offPeakWindowOptions disabled', () => {
+    new Domain(stack, 'Domain', {
+      version: engineVersion,
+      offPeakWindowOptions: {
+        enabled: false,
+      },
+    });
+
+    Template.fromStack(stack).hasResourceProperties('AWS::OpenSearchService::Domain', {
+      OffPeakWindowOptions: {
+        Enabled: false,
+      },
+    });
+  });
+
+  test('offPeakWindowOptions default value', () => {
+    new Domain(stack, 'Domain', {
+      version: engineVersion,
+    });
+
+    Template.fromStack(stack).hasResourceProperties('AWS::OpenSearchService::Domain', {
+      OffPeakWindowOptions: {
+        Enabled: true,
+        OffPeakWindow: {
+          WindowStartTime: {
+            Hours: 0,
+            Minutes: 0,
+          },
+        },
+      },
+    });
+  });
+
   test('with softwareUpdateOptions', () => {
     new Domain(stack, 'Domain', {
       version: engineVersion,