Skip to content

Commit be0249f

Browse files
author
awstools
committed
feat(client-opensearch): This release adds support for SkipUnavailable connection property for cross cluster search
1 parent 4a4ed04 commit be0249f

File tree

6 files changed

+117
-14
lines changed

6 files changed

+117
-14
lines changed

clients/client-opensearch/src/commands/CreateOutboundConnectionCommand.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,12 @@ export interface CreateOutboundConnectionCommandOutput extends CreateOutboundCon
6262
* },
6363
* ConnectionAlias: "STRING_VALUE", // required
6464
* ConnectionMode: "DIRECT" || "VPC_ENDPOINT",
65+
* ConnectionProperties: { // ConnectionProperties
66+
* Endpoint: "STRING_VALUE",
67+
* CrossClusterSearch: { // CrossClusterSearchConnectionProperties
68+
* SkipUnavailable: "ENABLED" || "DISABLED",
69+
* },
70+
* },
6571
* };
6672
* const command = new CreateOutboundConnectionCommand(input);
6773
* const response = await client.send(command);
@@ -89,6 +95,9 @@ export interface CreateOutboundConnectionCommandOutput extends CreateOutboundCon
8995
* // ConnectionMode: "DIRECT" || "VPC_ENDPOINT",
9096
* // ConnectionProperties: { // ConnectionProperties
9197
* // Endpoint: "STRING_VALUE",
98+
* // CrossClusterSearch: { // CrossClusterSearchConnectionProperties
99+
* // SkipUnavailable: "ENABLED" || "DISABLED",
100+
* // },
92101
* // },
93102
* // };
94103
*

clients/client-opensearch/src/commands/DeleteOutboundConnectionCommand.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,9 @@ export interface DeleteOutboundConnectionCommandOutput extends DeleteOutboundCon
7575
* // ConnectionMode: "DIRECT" || "VPC_ENDPOINT",
7676
* // ConnectionProperties: { // ConnectionProperties
7777
* // Endpoint: "STRING_VALUE",
78+
* // CrossClusterSearch: { // CrossClusterSearchConnectionProperties
79+
* // SkipUnavailable: "ENABLED" || "DISABLED",
80+
* // },
7881
* // },
7982
* // },
8083
* // };

clients/client-opensearch/src/commands/DescribeOutboundConnectionsCommand.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,9 @@ export interface DescribeOutboundConnectionsCommandOutput
9090
* // ConnectionMode: "DIRECT" || "VPC_ENDPOINT",
9191
* // ConnectionProperties: { // ConnectionProperties
9292
* // Endpoint: "STRING_VALUE",
93+
* // CrossClusterSearch: { // CrossClusterSearchConnectionProperties
94+
* // SkipUnavailable: "ENABLED" || "DISABLED",
95+
* // },
9396
* // },
9497
* // },
9598
* // ],

clients/client-opensearch/src/models/models_0.ts

Lines changed: 46 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2109,6 +2109,50 @@ export class ResourceAlreadyExistsException extends __BaseException {
21092109
}
21102110
}
21112111

2112+
/**
2113+
* @public
2114+
* @enum
2115+
*/
2116+
export const SkipUnavailableStatus = {
2117+
DISABLED: "DISABLED",
2118+
ENABLED: "ENABLED",
2119+
} as const;
2120+
2121+
/**
2122+
* @public
2123+
*/
2124+
export type SkipUnavailableStatus = (typeof SkipUnavailableStatus)[keyof typeof SkipUnavailableStatus];
2125+
2126+
/**
2127+
* @public
2128+
* <p>Cross cluster search specific connection properties.</p>
2129+
*/
2130+
export interface CrossClusterSearchConnectionProperties {
2131+
/**
2132+
* <p>Status of SkipUnavailable param for outbound connection.</p>
2133+
*/
2134+
SkipUnavailable?: SkipUnavailableStatus | string;
2135+
}
2136+
2137+
/**
2138+
* @public
2139+
* <p>The connection properties of an outbound connection.</p>
2140+
*/
2141+
export interface ConnectionProperties {
2142+
/**
2143+
* <important>
2144+
* <p>The Endpoint attribute cannot be modified. </p>
2145+
* </important>
2146+
* <p>The endpoint of the remote domain. Applicable for VPC_ENDPOINT connection mode.</p>
2147+
*/
2148+
Endpoint?: string;
2149+
2150+
/**
2151+
* <p>The connection properties for cross cluster search.</p>
2152+
*/
2153+
CrossClusterSearch?: CrossClusterSearchConnectionProperties;
2154+
}
2155+
21122156
/**
21132157
* @public
21142158
* <p>Container for the parameters to the <code>CreateOutboundConnection</code> operation.</p>
@@ -2133,17 +2177,11 @@ export interface CreateOutboundConnectionRequest {
21332177
* <p>The connection mode.</p>
21342178
*/
21352179
ConnectionMode?: ConnectionMode | string;
2136-
}
21372180

2138-
/**
2139-
* @public
2140-
* <p>The connection properties of an outbound connection.</p>
2141-
*/
2142-
export interface ConnectionProperties {
21432181
/**
2144-
* <p>The endpoint of the remote domain.</p>
2182+
* <p>The <code>ConnectionProperties</code> for the outbound connection.</p>
21452183
*/
2146-
Endpoint?: string;
2184+
ConnectionProperties?: ConnectionProperties;
21472185
}
21482186

21492187
/**

clients/client-opensearch/src/protocols/Aws_restJson1.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,8 @@ import {
192192
CognitoOptionsStatus,
193193
ColdStorageOptions,
194194
ConflictException,
195+
ConnectionProperties,
196+
CrossClusterSearchConnectionProperties,
195197
DependencyFailureException,
196198
DescribePackagesFilter,
197199
DisabledOperationException,
@@ -466,6 +468,7 @@ export const se_CreateOutboundConnectionCommand = async (
466468
take(input, {
467469
ConnectionAlias: [],
468470
ConnectionMode: [],
471+
ConnectionProperties: (_) => _json(_),
469472
LocalDomainInfo: (_) => _json(_),
470473
RemoteDomainInfo: (_) => _json(_),
471474
})
@@ -5367,6 +5370,10 @@ const se_AutoTuneOptionsInput = (input: AutoTuneOptionsInput, context: __SerdeCo
53675370

53685371
// se_ColdStorageOptions omitted.
53695372

5373+
// se_ConnectionProperties omitted.
5374+
5375+
// se_CrossClusterSearchConnectionProperties omitted.
5376+
53705377
// se_DescribePackagesFilter omitted.
53715378

53725379
// se_DescribePackagesFilterList omitted.
@@ -5653,6 +5660,8 @@ const de_CognitoOptionsStatus = (output: any, context: __SerdeContext): CognitoO
56535660

56545661
// de_ConnectionProperties omitted.
56555662

5663+
// de_CrossClusterSearchConnectionProperties omitted.
5664+
56565665
/**
56575666
* deserializeAws_restJson1DomainConfig
56585667
*/

codegen/sdk-codegen/aws-models/opensearch.json

Lines changed: 47 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2766,7 +2766,13 @@
27662766
"Endpoint": {
27672767
"target": "com.amazonaws.opensearch#Endpoint",
27682768
"traits": {
2769-
"smithy.api#documentation": "<p>The endpoint of the remote domain.</p>"
2769+
"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>"
2770+
}
2771+
},
2772+
"CrossClusterSearch": {
2773+
"target": "com.amazonaws.opensearch#CrossClusterSearchConnectionProperties",
2774+
"traits": {
2775+
"smithy.api#documentation": "<p>The connection properties for cross cluster search.</p>"
27702776
}
27712777
}
27722778
},
@@ -3009,6 +3015,12 @@
30093015
"traits": {
30103016
"smithy.api#documentation": "<p>The connection mode.</p>"
30113017
}
3018+
},
3019+
"ConnectionProperties": {
3020+
"target": "com.amazonaws.opensearch#ConnectionProperties",
3021+
"traits": {
3022+
"smithy.api#documentation": "<p>The <code>ConnectionProperties</code> for the outbound connection.</p>"
3023+
}
30123024
}
30133025
},
30143026
"traits": {
@@ -3241,6 +3253,20 @@
32413253
"com.amazonaws.opensearch#CreatedAt": {
32423254
"type": "timestamp"
32433255
},
3256+
"com.amazonaws.opensearch#CrossClusterSearchConnectionProperties": {
3257+
"type": "structure",
3258+
"members": {
3259+
"SkipUnavailable": {
3260+
"target": "com.amazonaws.opensearch#SkipUnavailableStatus",
3261+
"traits": {
3262+
"smithy.api#documentation": "<p>Status of SkipUnavailable param for outbound connection.</p>"
3263+
}
3264+
}
3265+
},
3266+
"traits": {
3267+
"smithy.api#documentation": "<p>Cross cluster search specific connection properties.</p>"
3268+
}
3269+
},
32443270
"com.amazonaws.opensearch#DeleteDomain": {
32453271
"type": "operation",
32463272
"input": {
@@ -4597,11 +4623,6 @@
45974623
"type": "list",
45984624
"member": {
45994625
"target": "com.amazonaws.opensearch#DescribePackagesFilterValue"
4600-
},
4601-
"traits": {
4602-
"smithy.api#length": {
4603-
"min": 1
4604-
}
46054626
}
46064627
},
46074628
"com.amazonaws.opensearch#DescribePackagesRequest": {
@@ -9929,6 +9950,26 @@
99299950
"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>"
99309951
}
99319952
},
9953+
"com.amazonaws.opensearch#SkipUnavailableStatus": {
9954+
"type": "enum",
9955+
"members": {
9956+
"ENABLED": {
9957+
"target": "smithy.api#Unit",
9958+
"traits": {
9959+
"smithy.api#enumValue": "ENABLED"
9960+
}
9961+
},
9962+
"DISABLED": {
9963+
"target": "smithy.api#Unit",
9964+
"traits": {
9965+
"smithy.api#enumValue": "DISABLED"
9966+
}
9967+
}
9968+
},
9969+
"traits": {
9970+
"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>"
9971+
}
9972+
},
99329973
"com.amazonaws.opensearch#SlotList": {
99339974
"type": "list",
99349975
"member": {

0 commit comments

Comments
 (0)