feat(opensearchservice): L2 properties for offPeakWindowOptions and softwareUpdateOptions

packages/@aws-cdk-testing/framework-integ/test/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",

packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.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",

packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.cognitodashboardsauth.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",

packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.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",

packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.js.snapshot/cdk-integ-opensearch.template.json

@@ -152,6 +152,18 @@
     },
     "NodeToNodeEncryptionOptions": {
      "Enabled": true
+    },
+    "OffPeakWindowOptions": {
+      "Enabled": true,
+      "OffPeakWindow": {
+        "WindowStartTime": {
+          "Hours": 20,
+          "Minutes": 0
+        }
+      }
+    },
+    "SoftwareUpdateOptions": {
+      "AutoSoftwareUpdateEnabled": true
     }
    },
    "DependsOn": [
@@ -458,6 +470,18 @@
     },
     "NodeToNodeEncryptionOptions": {
      "Enabled": true
+    },
+    "OffPeakWindowOptions": {
+      "Enabled": true,
+      "OffPeakWindow": {
+        "WindowStartTime": {
+          "Hours": 20,
+          "Minutes": 0
+        }
+      }
+    },
+    "SoftwareUpdateOptions": {
+      "AutoSoftwareUpdateEnabled": true
     }
    },
    "DependsOn": [

packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/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",

packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.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",

packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.ts

@@ -41,6 +41,18 @@ class TestStack extends Stack {
       capacity: {
         multiAzWithStandbyEnabled: false,
       },
+      offPeakWindowOptions: {
+        enabled: true,
+        offPeakWindow: {
+          windowStartTime: {
+            hours: 20,
+            minutes: 0,
+          },
+        },
+      },
+      softwareUpdateOptions: {
+        autoSoftwareUpdateEnabled: true,
+      },
     };
 
     // create 2 domains to ensure that Cloudwatch Log Group policy names dont conflict

packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/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",

packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/test/integ.opensearch.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",

packages/@aws-cdk-testing/framework-integ/test/aws-opensearchservice/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": [

packages/aws-cdk-lib/aws-opensearchservice/README.md

@@ -396,4 +396,40 @@ const domain = new Domain(this, 'Domain', {
     dataNodes: 3,
   },
 });
+```
+
+## Define off-peak windows
+
+The domain can be configured to use a daily 10-hour window considered as off-peak hours.
+
+> Visit [Defining off-peak windows for Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html) for more details.
+
+```ts
+const domain = new Domain(this, 'Domain', {
+  version: EngineVersion.OPENSEARCH_1_3,
+  offPeakWindowOptions: {
+    enabled: true,
+    offPeakWindow: {
+      windowStartTime: {
+        hours: 20,
+        minutes: 0,
+      },
+    },
+  },
+});
+```
+
+## Configuring service software updates
+
+The domain can be configured to use service software updates.
+
+> Visit [Service software updates in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html) for more details.
+
+```ts
+const domain = new Domain(this, 'Domain', {
+  version: EngineVersion.OPENSEARCH_1_3,
+  softwareUpdateOptions: {
+    autoSoftwareUpdateEnabled: true,
+  },
+});
 ```

packages/aws-cdk-lib/aws-opensearchservice/lib/domain.ts

@@ -328,6 +328,65 @@ export interface CustomEndpointOptions {
   readonly hostedZone?: route53.IHostedZone;
 }
 
+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;
+}
+
+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;
+}
+
+/**
+ * Options for configuring service software updates for a domain.
+ */
+export interface SoftwareUpdateOptions {
+  /**
+   * Specifies whether automatic service software updates are enabled for the domain.
+   *
+   * @default - automatic software updates are disabled
+   */
+  readonly autoSoftwareUpdateEnabled?: boolean;
+}
+
 /**
  * Properties for an Amazon OpenSearch Service domain.
  */
@@ -511,6 +570,21 @@ export interface DomainProps {
    * @default - no custom domain endpoint will be configured
    */
   readonly customEndpoint?: CustomEndpointOptions;
+
+  /**
+   * 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;
 }
 
 /**
@@ -1558,6 +1632,23 @@ export class Domain extends DomainBase implements IDomain, ec2.IConnectable {
       }
     }
 
+    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', {
       domainName: this.physicalName,
@@ -1632,6 +1723,8 @@ export class Domain extends DomainBase implements IDomain, ec2.IConnectable {
         }
         : undefined,
       advancedOptions: props.advancedOptions,
+      offPeakWindowOptions: offPeakWindowOptions,
+      softwareUpdateOptions: props.softwareUpdateOptions,
     });
     this.domain.applyRemovalPolicy(props.removalPolicy);
 
@@ -1689,6 +1782,20 @@ export class Domain extends DomainBase implements IDomain, ec2.IConnectable {
     }
   }
 
+  /**
+   * Validate windowStartTime property according to
+   * https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-windowstarttime.html
+   */
+  private validateWindowStartTime(windowStartTime?: WindowStartTime) {
+    if (!windowStartTime) return;
+    if (windowStartTime.hours < 0 || windowStartTime.hours > 23) {
+      throw new Error(`Hours must be a value between 0 and 23, but got ${windowStartTime.hours}.`);
+    }
+    if (windowStartTime.minutes < 0 || windowStartTime.minutes > 59) {
+      throw new Error(`Minutes must be a value between 0 and 59, but got ${windowStartTime.minutes}.`);
+    }
+  }
+
   /**
    * Manages network connections to the domain. This will throw an error in case the domain
    * is not placed inside a VPC.