feat(client-opensearch): This release adds support for SkipUnavailabl…

…e connection property for cross cluster search
aws · Jun 12, 2023 · be0249f · be0249f
1 parent 4a4ed04
commit be0249f
Show file tree

Hide file tree

Showing 6 changed files with 117 additions and 14 deletions.
diff --git a/clients/client-opensearch/src/commands/CreateOutboundConnectionCommand.ts b/clients/client-opensearch/src/commands/CreateOutboundConnectionCommand.ts
@@ -62,6 +62,12 @@ export interface CreateOutboundConnectionCommandOutput extends CreateOutboundCon
  *   },
  *   ConnectionAlias: "STRING_VALUE", // required
  *   ConnectionMode: "DIRECT" || "VPC_ENDPOINT",
+ *   ConnectionProperties: { // ConnectionProperties
+ *     Endpoint: "STRING_VALUE",
+ *     CrossClusterSearch: { // CrossClusterSearchConnectionProperties
+ *       SkipUnavailable: "ENABLED" || "DISABLED",
+ *     },
+ *   },
  * };
  * const command = new CreateOutboundConnectionCommand(input);
  * const response = await client.send(command);
@@ -89,6 +95,9 @@ export interface CreateOutboundConnectionCommandOutput extends CreateOutboundCon
  * //   ConnectionMode: "DIRECT" || "VPC_ENDPOINT",
  * //   ConnectionProperties: { // ConnectionProperties
  * //     Endpoint: "STRING_VALUE",
+ * //     CrossClusterSearch: { // CrossClusterSearchConnectionProperties
+ * //       SkipUnavailable: "ENABLED" || "DISABLED",
+ * //     },
  * //   },
  * // };
  *

diff --git a/clients/client-opensearch/src/commands/DeleteOutboundConnectionCommand.ts b/clients/client-opensearch/src/commands/DeleteOutboundConnectionCommand.ts
@@ -75,6 +75,9 @@ export interface DeleteOutboundConnectionCommandOutput extends DeleteOutboundCon
  * //     ConnectionMode: "DIRECT" || "VPC_ENDPOINT",
  * //     ConnectionProperties: { // ConnectionProperties
  * //       Endpoint: "STRING_VALUE",
+ * //       CrossClusterSearch: { // CrossClusterSearchConnectionProperties
+ * //         SkipUnavailable: "ENABLED" || "DISABLED",
+ * //       },
  * //     },
  * //   },
  * // };

diff --git a/clients/client-opensearch/src/commands/DescribeOutboundConnectionsCommand.ts b/clients/client-opensearch/src/commands/DescribeOutboundConnectionsCommand.ts
@@ -90,6 +90,9 @@ export interface DescribeOutboundConnectionsCommandOutput
  * //       ConnectionMode: "DIRECT" || "VPC_ENDPOINT",
  * //       ConnectionProperties: { // ConnectionProperties
  * //         Endpoint: "STRING_VALUE",
+ * //         CrossClusterSearch: { // CrossClusterSearchConnectionProperties
+ * //           SkipUnavailable: "ENABLED" || "DISABLED",
+ * //         },
  * //       },
  * //     },
  * //   ],

diff --git a/clients/client-opensearch/src/models/models_0.ts b/clients/client-opensearch/src/models/models_0.ts
@@ -2109,6 +2109,50 @@ export class ResourceAlreadyExistsException extends __BaseException {
   }
 }
 
+/**
+ * @public
+ * @enum
+ */
+export const SkipUnavailableStatus = {
+  DISABLED: "DISABLED",
+  ENABLED: "ENABLED",
+} as const;
+
+/**
+ * @public
+ */
+export type SkipUnavailableStatus = (typeof SkipUnavailableStatus)[keyof typeof SkipUnavailableStatus];
+
+/**
+ * @public
+ * <p>Cross cluster search specific connection properties.</p>
+ */
+export interface CrossClusterSearchConnectionProperties {
+  /**
+   * <p>Status of SkipUnavailable param for outbound connection.</p>
+   */
+  SkipUnavailable?: SkipUnavailableStatus | string;
+}
+
+/**
+ * @public
+ * <p>The connection properties of an outbound connection.</p>
+ */
+export interface ConnectionProperties {
+  /**
+   * <important>
+   *             <p>The Endpoint attribute cannot be modified. </p>
+   *          </important>
+   *          <p>The endpoint of the remote domain. Applicable for VPC_ENDPOINT connection mode.</p>
+   */
+  Endpoint?: string;
+
+  /**
+   * <p>The connection properties for cross cluster search.</p>
+   */
+  CrossClusterSearch?: CrossClusterSearchConnectionProperties;
+}
+
 /**
  * @public
  * <p>Container for the parameters to the <code>CreateOutboundConnection</code> operation.</p>
@@ -2133,17 +2177,11 @@ export interface CreateOutboundConnectionRequest {
    * <p>The connection mode.</p>
    */
   ConnectionMode?: ConnectionMode | string;
-}
 
-/**
- * @public
- * <p>The connection properties of an outbound connection.</p>
- */
-export interface ConnectionProperties {
   /**
-   * <p>The endpoint of the remote domain.</p>
+   * <p>The <code>ConnectionProperties</code> for the outbound connection.</p>
    */
-  Endpoint?: string;
+  ConnectionProperties?: ConnectionProperties;
 }
 
 /**

diff --git a/clients/client-opensearch/src/protocols/Aws_restJson1.ts b/clients/client-opensearch/src/protocols/Aws_restJson1.ts
@@ -192,6 +192,8 @@ import {
   CognitoOptionsStatus,
   ColdStorageOptions,
   ConflictException,
+  ConnectionProperties,
+  CrossClusterSearchConnectionProperties,
   DependencyFailureException,
   DescribePackagesFilter,
   DisabledOperationException,
@@ -466,6 +468,7 @@ export const se_CreateOutboundConnectionCommand = async (
     take(input, {
       ConnectionAlias: [],
       ConnectionMode: [],
+      ConnectionProperties: (_) => _json(_),
       LocalDomainInfo: (_) => _json(_),
       RemoteDomainInfo: (_) => _json(_),
     })
@@ -5367,6 +5370,10 @@ const se_AutoTuneOptionsInput = (input: AutoTuneOptionsInput, context: __SerdeCo
 
 // se_ColdStorageOptions omitted.
 
+// se_ConnectionProperties omitted.
+
+// se_CrossClusterSearchConnectionProperties omitted.
+
 // se_DescribePackagesFilter omitted.
 
 // se_DescribePackagesFilterList omitted.
@@ -5653,6 +5660,8 @@ const de_CognitoOptionsStatus = (output: any, context: __SerdeContext): CognitoO
 
 // de_ConnectionProperties omitted.
 
+// de_CrossClusterSearchConnectionProperties omitted.
+
 /**
  * deserializeAws_restJson1DomainConfig
  */

diff --git a/codegen/sdk-codegen/aws-models/opensearch.json b/codegen/sdk-codegen/aws-models/opensearch.json
@@ -2766,7 +2766,13 @@
         "Endpoint": {
           "target": "com.amazonaws.opensearch#Endpoint",
           "traits": {
-            "smithy.api#documentation": "<p>The endpoint of the remote domain.</p>"
+            "smithy.api#documentation": "<important>\n            <p>The Endpoint attribute cannot be modified. </p>\n         </important>\n         <p>The endpoint of the remote domain. Applicable for VPC_ENDPOINT connection mode.</p>"
+          }
+        },
+        "CrossClusterSearch": {
+          "target": "com.amazonaws.opensearch#CrossClusterSearchConnectionProperties",
+          "traits": {
+            "smithy.api#documentation": "<p>The connection properties for cross cluster search.</p>"
           }
         }
       },
@@ -3009,6 +3015,12 @@
           "traits": {
             "smithy.api#documentation": "<p>The connection mode.</p>"
           }
+        },
+        "ConnectionProperties": {
+          "target": "com.amazonaws.opensearch#ConnectionProperties",
+          "traits": {
+            "smithy.api#documentation": "<p>The <code>ConnectionProperties</code> for the outbound connection.</p>"
+          }
         }
       },
       "traits": {
@@ -3241,6 +3253,20 @@
     "com.amazonaws.opensearch#CreatedAt": {
       "type": "timestamp"
     },
+    "com.amazonaws.opensearch#CrossClusterSearchConnectionProperties": {
+      "type": "structure",
+      "members": {
+        "SkipUnavailable": {
+          "target": "com.amazonaws.opensearch#SkipUnavailableStatus",
+          "traits": {
+            "smithy.api#documentation": "<p>Status of SkipUnavailable param for outbound connection.</p>"
+          }
+        }
+      },
+      "traits": {
+        "smithy.api#documentation": "<p>Cross cluster search specific connection properties.</p>"
+      }
+    },
     "com.amazonaws.opensearch#DeleteDomain": {
       "type": "operation",
       "input": {
@@ -4597,11 +4623,6 @@
       "type": "list",
       "member": {
         "target": "com.amazonaws.opensearch#DescribePackagesFilterValue"
-      },
-      "traits": {
-        "smithy.api#length": {
-          "min": 1
-        }
       }
     },
     "com.amazonaws.opensearch#DescribePackagesRequest": {
@@ -9929,6 +9950,26 @@
         "smithy.api#documentation": "<p>The domain endpoint to which index and search requests are submitted. For example,\n    <code>search-imdb-movies-oopcnjfn6ugo.eu-west-1.es.amazonaws.com</code> or\n    <code>doc-imdb-movies-oopcnjfn6u.eu-west-1.es.amazonaws.com</code>.</p>"
       }
     },
+    "com.amazonaws.opensearch#SkipUnavailableStatus": {
+      "type": "enum",
+      "members": {
+        "ENABLED": {
+          "target": "smithy.api#Unit",
+          "traits": {
+            "smithy.api#enumValue": "ENABLED"
+          }
+        },
+        "DISABLED": {
+          "target": "smithy.api#Unit",
+          "traits": {
+            "smithy.api#enumValue": "DISABLED"
+          }
+        }
+      },
+      "traits": {
+        "smithy.api#documentation": "<p>Status of SkipUnavailable param for outbound connection.</p>\n         <ul>\n            <li>\n               <p>\n                  <b>ENABLED</b> - The SkipUnavailable param is enabled\n    for the connection.</p>\n            </li>\n            <li>\n               <p>\n                  <b>DISABLED</b> - The SkipUnavailable param is disabled\n     for the connection.</p>\n            </li>\n         </ul>"
+      }
+    },
     "com.amazonaws.opensearch#SlotList": {
       "type": "list",
       "member": {