Skip to content

Commit c790f71

Browse files
author
awstools
committed
feat(client-opensearch): This release adds support for new or existing Amazon OpenSearch domains to enable TLS 1.3 or TLS 1.2 with perfect forward secrecy cipher suites for domain endpoints.
1 parent 89d32d2 commit c790f71

File tree

9 files changed

+54
-31
lines changed

9 files changed

+54
-31
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad
100100
* },
101101
* DomainEndpointOptions: { // DomainEndpointOptions
102102
* EnforceHTTPS: true || false,
103-
* TLSSecurityPolicy: "Policy-Min-TLS-1-0-2019-07" || "Policy-Min-TLS-1-2-2019-07",
103+
* TLSSecurityPolicy: "Policy-Min-TLS-1-0-2019-07" || "Policy-Min-TLS-1-2-2019-07" || "Policy-Min-TLS-1-2-PFS-2023-10",
104104
* CustomEndpointEnabled: true || false,
105105
* CustomEndpoint: "STRING_VALUE",
106106
* CustomEndpointCertificateArn: "STRING_VALUE",
@@ -253,7 +253,7 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad
253253
* // },
254254
* // DomainEndpointOptions: { // DomainEndpointOptions
255255
* // EnforceHTTPS: true || false,
256-
* // TLSSecurityPolicy: "Policy-Min-TLS-1-0-2019-07" || "Policy-Min-TLS-1-2-2019-07",
256+
* // TLSSecurityPolicy: "Policy-Min-TLS-1-0-2019-07" || "Policy-Min-TLS-1-2-2019-07" || "Policy-Min-TLS-1-2-PFS-2023-10",
257257
* // CustomEndpointEnabled: true || false,
258258
* // CustomEndpoint: "STRING_VALUE",
259259
* // CustomEndpointCertificateArn: "STRING_VALUE",

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ export interface DeleteDomainCommandOutput extends DeleteDomainResponse, __Metad
132132
* // },
133133
* // DomainEndpointOptions: { // DomainEndpointOptions
134134
* // EnforceHTTPS: true || false,
135-
* // TLSSecurityPolicy: "Policy-Min-TLS-1-0-2019-07" || "Policy-Min-TLS-1-2-2019-07",
135+
* // TLSSecurityPolicy: "Policy-Min-TLS-1-0-2019-07" || "Policy-Min-TLS-1-2-2019-07" || "Policy-Min-TLS-1-2-PFS-2023-10",
136136
* // CustomEndpointEnabled: true || false,
137137
* // CustomEndpoint: "STRING_VALUE",
138138
* // CustomEndpointCertificateArn: "STRING_VALUE",

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ export interface DescribeDomainCommandOutput extends DescribeDomainResponse, __M
132132
* // },
133133
* // DomainEndpointOptions: { // DomainEndpointOptions
134134
* // EnforceHTTPS: true || false,
135-
* // TLSSecurityPolicy: "Policy-Min-TLS-1-0-2019-07" || "Policy-Min-TLS-1-2-2019-07",
135+
* // TLSSecurityPolicy: "Policy-Min-TLS-1-0-2019-07" || "Policy-Min-TLS-1-2-2019-07" || "Policy-Min-TLS-1-2-PFS-2023-10",
136136
* // CustomEndpointEnabled: true || false,
137137
* // CustomEndpoint: "STRING_VALUE",
138138
* // CustomEndpointCertificateArn: "STRING_VALUE",

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ export interface DescribeDomainConfigCommandOutput extends DescribeDomainConfigR
176176
* // DomainEndpointOptions: { // DomainEndpointOptionsStatus
177177
* // Options: { // DomainEndpointOptions
178178
* // EnforceHTTPS: true || false,
179-
* // TLSSecurityPolicy: "Policy-Min-TLS-1-0-2019-07" || "Policy-Min-TLS-1-2-2019-07",
179+
* // TLSSecurityPolicy: "Policy-Min-TLS-1-0-2019-07" || "Policy-Min-TLS-1-2-2019-07" || "Policy-Min-TLS-1-2-PFS-2023-10",
180180
* // CustomEndpointEnabled: true || false,
181181
* // CustomEndpoint: "STRING_VALUE",
182182
* // CustomEndpointCertificateArn: "STRING_VALUE",

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ export interface DescribeDomainsCommandOutput extends DescribeDomainsResponse, _
135135
* // },
136136
* // DomainEndpointOptions: { // DomainEndpointOptions
137137
* // EnforceHTTPS: true || false,
138-
* // TLSSecurityPolicy: "Policy-Min-TLS-1-0-2019-07" || "Policy-Min-TLS-1-2-2019-07",
138+
* // TLSSecurityPolicy: "Policy-Min-TLS-1-0-2019-07" || "Policy-Min-TLS-1-2-2019-07" || "Policy-Min-TLS-1-2-PFS-2023-10",
139139
* // CustomEndpointEnabled: true || false,
140140
* // CustomEndpoint: "STRING_VALUE",
141141
* // CustomEndpointCertificateArn: "STRING_VALUE",

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ export interface DescribeDryRunProgressCommandOutput extends DescribeDryRunProgr
146146
* // },
147147
* // DomainEndpointOptions: { // DomainEndpointOptions
148148
* // EnforceHTTPS: true || false,
149-
* // TLSSecurityPolicy: "Policy-Min-TLS-1-0-2019-07" || "Policy-Min-TLS-1-2-2019-07",
149+
* // TLSSecurityPolicy: "Policy-Min-TLS-1-0-2019-07" || "Policy-Min-TLS-1-2-2019-07" || "Policy-Min-TLS-1-2-PFS-2023-10",
150150
* // CustomEndpointEnabled: true || false,
151151
* // CustomEndpoint: "STRING_VALUE",
152152
* // CustomEndpointCertificateArn: "STRING_VALUE",

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ export interface UpdateDomainConfigCommandOutput extends UpdateDomainConfigRespo
101101
* },
102102
* DomainEndpointOptions: { // DomainEndpointOptions
103103
* EnforceHTTPS: true || false,
104-
* TLSSecurityPolicy: "Policy-Min-TLS-1-0-2019-07" || "Policy-Min-TLS-1-2-2019-07",
104+
* TLSSecurityPolicy: "Policy-Min-TLS-1-0-2019-07" || "Policy-Min-TLS-1-2-2019-07" || "Policy-Min-TLS-1-2-PFS-2023-10",
105105
* CustomEndpointEnabled: true || false,
106106
* CustomEndpoint: "STRING_VALUE",
107107
* CustomEndpointCertificateArn: "STRING_VALUE",
@@ -299,7 +299,7 @@ export interface UpdateDomainConfigCommandOutput extends UpdateDomainConfigRespo
299299
* // DomainEndpointOptions: { // DomainEndpointOptionsStatus
300300
* // Options: { // DomainEndpointOptions
301301
* // EnforceHTTPS: true || false,
302-
* // TLSSecurityPolicy: "Policy-Min-TLS-1-0-2019-07" || "Policy-Min-TLS-1-2-2019-07",
302+
* // TLSSecurityPolicy: "Policy-Min-TLS-1-0-2019-07" || "Policy-Min-TLS-1-2-2019-07" || "Policy-Min-TLS-1-2-PFS-2023-10",
303303
* // CustomEndpointEnabled: true || false,
304304
* // CustomEndpoint: "STRING_VALUE",
305305
* // CustomEndpointCertificateArn: "STRING_VALUE",

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

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1626,6 +1626,7 @@ export interface CognitoOptions {
16261626
export const TLSSecurityPolicy = {
16271627
POLICY_MIN_TLS_1_0_2019_07: "Policy-Min-TLS-1-0-2019-07",
16281628
POLICY_MIN_TLS_1_2_2019_07: "Policy-Min-TLS-1-2-2019-07",
1629+
POLICY_MIN_TLS_1_2_PFS_2023_10: "Policy-Min-TLS-1-2-PFS-2023-10",
16291630
} as const;
16301631

16311632
/**
@@ -1659,6 +1660,11 @@ export interface DomainEndpointOptions {
16591660
* <b>Policy-Min-TLS-1-2-2019-07:</b> TLS security policy that
16601661
* supports only TLS version 1.2</p>
16611662
* </li>
1663+
* <li>
1664+
* <p>
1665+
* <b>Policy-Min-TLS-1-2-PFS-2023-10:</b> TLS security policy that
1666+
* supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites</p>
1667+
* </li>
16621668
* </ul>
16631669
*/
16641670
TLSSecurityPolicy?: TLSSecurityPolicy;
@@ -1977,7 +1983,9 @@ export interface CreateDomainRequest {
19771983

19781984
/**
19791985
* @public
1980-
* <p>The type of IP addresses supported by the endpoint for the domain.</p>
1986+
* <p>Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share
1987+
* domain resources across IPv4 and IPv6 address types, and is the recommended option.
1988+
* If you set your IP address type to dual stack, you can't change your address type later.</p>
19811989
*/
19821990
IPAddressType?: IPAddressType;
19831991

@@ -2246,15 +2254,16 @@ export interface DomainStatus {
22462254

22472255
/**
22482256
* @public
2249-
* <p>The domain endpoint to which index and search requests are submitted. For example,
2250-
* <code>search-imdb-movies-oopcnjfn6ugo.eu-west-1.es.amazonaws.com</code> or
2251-
* <code>doc-imdb-movies-oopcnjfn6u.eu-west-1.es.amazonaws.com</code>.</p>
2257+
* <p>If <code>IPAddressType</code> to set to <code>dualstack</code>, a version 2 domain endpoint is provisioned.
2258+
* This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses.
2259+
* Normal endpoints work only with IPv4 IP addresses.
2260+
* </p>
22522261
*/
22532262
EndpointV2?: string;
22542263

22552264
/**
22562265
* @public
2257-
* <p>The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints.. Example
2266+
* <p>The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. Example
22582267
* <code>key, value</code>:
22592268
* <code>'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'</code>.</p>
22602269
*/
@@ -3888,7 +3897,9 @@ export interface DomainConfig {
38883897

38893898
/**
38903899
* @public
3891-
* <p>The type of IP addresses supported by the endpoint for the domain.</p>
3900+
* <p>Choose either dual stack or IPv4 as your IP address type.
3901+
* Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option.
3902+
* If you set your IP address type to dual stack, you can't change your address type later.</p>
38923903
*/
38933904
IPAddressType?: IPAddressTypeStatus;
38943905

@@ -4883,15 +4894,15 @@ export interface DescribePackagesRequest {
48834894
/**
48844895
* @public
48854896
* <p>An optional parameter that specifies the maximum number of results to return. You can use
4886-
* <code>nextToken</code> to get the next page of results.</p>
4897+
* <code>nextToken</code> to get the next page of results.</p>
48874898
*/
48884899
MaxResults?: number;
48894900

48904901
/**
48914902
* @public
48924903
* <p>If your initial <code>DescribePackageFilters</code> operation returns a
4893-
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent
4894-
* <code>DescribePackageFilters</code> operations, which returns results in the next page.</p>
4904+
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent
4905+
* <code>DescribePackageFilters</code> operations, which returns results in the next page.</p>
48954906
*/
48964907
NextToken?: string;
48974908
}
@@ -4910,7 +4921,7 @@ export interface DescribePackagesResponse {
49104921
/**
49114922
* @public
49124923
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
4913-
* <code>nextToken</code> is a unique pagination token for each page. Make the call again using the
4924+
* <code>nextToken</code> is a unique pagination token for each page. Make the call again using the
49144925
* returned token to retrieve the next page.</p>
49154926
*/
49164927
NextToken?: string;
@@ -6875,7 +6886,10 @@ export interface UpdateDomainConfigRequest {
68756886

68766887
/**
68776888
* @public
6878-
* <p>The type of IP addresses supported by the endpoint for the domain.</p>
6889+
* <p>Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across
6890+
* IPv4 and IPv6 address types, and is the recommended option.
6891+
* If your IP address type is currently set to dual stack, you can't change it.
6892+
* </p>
68796893
*/
68806894
IPAddressType?: IPAddressType;
68816895

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

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
"com.amazonaws.opensearch#ARN": {
3333
"type": "string",
3434
"traits": {
35-
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the domain. See <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html\">Identifiers for IAM Entities\n </a> in <i>Using AWS Identity and Access Management</i> for more information.\n </p>",
35+
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the domain. See <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html\">Identifiers for IAM Entities\n </a> in <i>Using Amazon Web Services Identity and Access Management</i> for more information.\n </p>",
3636
"smithy.api#length": {
3737
"min": 20,
3838
"max": 2048
@@ -3015,7 +3015,7 @@
30153015
"IPAddressType": {
30163016
"target": "com.amazonaws.opensearch#IPAddressType",
30173017
"traits": {
3018-
"smithy.api#documentation": "<p>The type of IP addresses supported by the endpoint for the domain.</p>"
3018+
"smithy.api#documentation": "<p>Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share\n domain resources across IPv4 and IPv6 address types, and is the recommended option. \n If you set your IP address type to dual stack, you can't change your address type later.</p>"
30193019
}
30203020
},
30213021
"SnapshotOptions": {
@@ -4959,13 +4959,13 @@
49594959
"target": "com.amazonaws.opensearch#MaxResults",
49604960
"traits": {
49614961
"smithy.api#default": 0,
4962-
"smithy.api#documentation": "<p>An optional parameter that specifies the maximum number of results to return. You can use\n <code>nextToken</code> to get the next page of results.</p>"
4962+
"smithy.api#documentation": "<p>An optional parameter that specifies the maximum number of results to return. You can use\n <code>nextToken</code> to get the next page of results.</p>"
49634963
}
49644964
},
49654965
"NextToken": {
49664966
"target": "com.amazonaws.opensearch#NextToken",
49674967
"traits": {
4968-
"smithy.api#documentation": "<p>If your initial <code>DescribePackageFilters</code> operation returns a\n <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent\n <code>DescribePackageFilters</code> operations, which returns results in the next page.</p>"
4968+
"smithy.api#documentation": "<p>If your initial <code>DescribePackageFilters</code> operation returns a\n <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent\n <code>DescribePackageFilters</code> operations, which returns results in the next page.</p>"
49694969
}
49704970
}
49714971
},
@@ -4986,7 +4986,7 @@
49864986
"NextToken": {
49874987
"target": "com.amazonaws.opensearch#String",
49884988
"traits": {
4989-
"smithy.api#documentation": "<p>When <code>nextToken</code> is returned, there are more results available. The value of\n <code>nextToken</code> is a unique pagination token for each page. Make the call again using the\n returned token to retrieve the next page.</p>"
4989+
"smithy.api#documentation": "<p>When <code>nextToken</code> is returned, there are more results available. The value of\n <code>nextToken</code> is a unique pagination token for each page. Make the call again using the\n returned token to retrieve the next page.</p>"
49904990
}
49914991
}
49924992
},
@@ -5378,7 +5378,7 @@
53785378
"IPAddressType": {
53795379
"target": "com.amazonaws.opensearch#IPAddressTypeStatus",
53805380
"traits": {
5381-
"smithy.api#documentation": "<p>The type of IP addresses supported by the endpoint for the domain.</p>"
5381+
"smithy.api#documentation": "<p>Choose either dual stack or IPv4 as your IP address type. \n Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. \n If you set your IP address type to dual stack, you can't change your address type later.</p>"
53825382
}
53835383
},
53845384
"SnapshotOptions": {
@@ -5476,7 +5476,7 @@
54765476
"TLSSecurityPolicy": {
54775477
"target": "com.amazonaws.opensearch#TLSSecurityPolicy",
54785478
"traits": {
5479-
"smithy.api#documentation": "<p>Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can\n be one of the following values:</p>\n <ul>\n <li>\n <p>\n <b>Policy-Min-TLS-1-0-2019-07:</b> TLS security policy that\n supports TLS version 1.0 to TLS version 1.2</p>\n </li>\n <li>\n <p>\n <b>Policy-Min-TLS-1-2-2019-07:</b> TLS security policy that\n supports only TLS version 1.2</p>\n </li>\n </ul>"
5479+
"smithy.api#documentation": "<p>Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can\n be one of the following values:</p>\n <ul>\n <li>\n <p>\n <b>Policy-Min-TLS-1-0-2019-07:</b> TLS security policy that\n supports TLS version 1.0 to TLS version 1.2</p>\n </li>\n <li>\n <p>\n <b>Policy-Min-TLS-1-2-2019-07:</b> TLS security policy that\n supports only TLS version 1.2</p>\n </li>\n <li>\n <p>\n <b>Policy-Min-TLS-1-2-PFS-2023-10:</b> TLS security policy that\n supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites</p>\n </li>\n </ul>"
54805480
}
54815481
},
54825482
"CustomEndpointEnabled": {
@@ -5932,12 +5932,15 @@
59325932
}
59335933
},
59345934
"EndpointV2": {
5935-
"target": "com.amazonaws.opensearch#ServiceUrl"
5935+
"target": "com.amazonaws.opensearch#ServiceUrl",
5936+
"traits": {
5937+
"smithy.api#documentation": "<p>If <code>IPAddressType</code> to set to <code>dualstack</code>, a version 2 domain endpoint is provisioned.\n This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses.\n Normal endpoints work only with IPv4 IP addresses.\n </p>"
5938+
}
59365939
},
59375940
"Endpoints": {
59385941
"target": "com.amazonaws.opensearch#EndpointsMap",
59395942
"traits": {
5940-
"smithy.api#documentation": "<p>The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints.. Example\n <code>key, value</code>:\n <code>'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'</code>.</p>"
5943+
"smithy.api#documentation": "<p>The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. Example\n <code>key, value</code>:\n <code>'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'</code>.</p>"
59415944
}
59425945
},
59435946
"Processing": {
@@ -10966,7 +10969,7 @@
1096610969
}
1096710970
},
1096810971
"traits": {
10969-
"smithy.api#documentation": "<p>The status of <code>SkipUnavailable</code> setting for the outbound connection.</p>\n <ul>\n <li>\n <p>\n <b>ENABLED</b> - The <code>SkipUnavailable</code> setting is enabled\n for the connection.</p>\n </li>\n <li>\n <p>\n <b>DISABLED</b> - The <code>SkipUnavailable</code> setting is disabled\n for the connection.</p>\n </li>\n </ul>"
10972+
"smithy.api#documentation": "<p>The status of <code>SkipUnavailable</code> setting for the outbound connection.</p>\n <ul>\n <li>\n <p>\n <b>ENABLED</b> - The <code>SkipUnavailable</code> setting is enabled\n for the connection.</p>\n </li>\n <li>\n <p>\n <b>DISABLED</b> - The <code>SkipUnavailable</code> setting is disabled\n for the connection.</p>\n </li>\n </ul>"
1097010973
}
1097110974
},
1097210975
"com.amazonaws.opensearch#SlotList": {
@@ -11339,6 +11342,12 @@
1133911342
"traits": {
1134011343
"smithy.api#enumValue": "Policy-Min-TLS-1-2-2019-07"
1134111344
}
11345+
},
11346+
"POLICY_MIN_TLS_1_2_PFS_2023_10": {
11347+
"target": "smithy.api#Unit",
11348+
"traits": {
11349+
"smithy.api#enumValue": "Policy-Min-TLS-1-2-PFS-2023-10"
11350+
}
1134211351
}
1134311352
}
1134411353
},
@@ -11610,7 +11619,7 @@
1161011619
"IPAddressType": {
1161111620
"target": "com.amazonaws.opensearch#IPAddressType",
1161211621
"traits": {
11613-
"smithy.api#documentation": "<p>The type of IP addresses supported by the endpoint for the domain.</p>"
11622+
"smithy.api#documentation": "<p>Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across\n IPv4 and IPv6 address types, and is the recommended option. \n If your IP address type is currently set to dual stack, you can't change it.\n </p>"
1161411623
}
1161511624
},
1161611625
"LogPublishingOptions": {

0 commit comments

Comments
 (0)