Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(opensearch): rebrand Elasticsearch as OpenSearch
Amazon Elasticsearch Service is being rebranded to Amazon OpenSearch Service. All customer-facing references to Elasticsearch within AWS CDK must be replaced with their OpenSearch equivalent, including documentation and API. To avoid breaking existing customers, all API changes will be implemented as a deprecation of the old API and introduction of a new, rebranded API.
Concretely, this change consists of the following:
- add a disclaimer at the top of the @aws-cdk/aws-elasticsearch module README about the rebranding
- add migration instructions to the @aws-cdk/aws-elasticsearch module README
- introduce the @aws-cdk/aws-opensearch module
- copy all files from the Elasticsearch module
- uses new AWS::OpenSearch::Domain resource. CFN guarantees a no-replacement update when a resource moves from AWS::Elasticsearch::Domain to AWS::OpenSearch::Domain, meaning customers should be able to move from the old CDK module to the new one with no downtime.
- rename DomainProps.cognitoKibanaAuth -> DomainProps.cognitoDashboardsAuth
- replaces ElasticsearchVersion with OpenSearchVersion
- ElasticsearchVersion.V{major}_{minor} -> OpenSearchVersion.ELASTICSEARCH_{major}_{minor}
- ElasticsearchVersion.of(version: string) -> OpenSearchVersion.elasticsearch(version: string)
- introduces OpenSearchVersion.OPENSEARCH_1_0 and OpenSearchVersion.openSearch(version: string)
- replace .elasticsearch instance suffix with .search
- rename logical ID and type of a custom resource (Custom::ElasticsearchAccessPolicy -> Custom::OpenSearchAccessPolicy) that we generate to update the domain's access policy. This will cause a resource replacement, which will avoid a CloudFormation error (Update of resource type is not permitted) for stacks that switch modules
Closes #16467- Loading branch information
1 parent
ae09c16
commit e6c4ca5
Showing
42 changed files
with
11,429 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
16 changes: 16 additions & 0 deletions
16
packages/@aws-cdk/aws-elasticsearch/rosetta/migrate-opensearch.ts-fixture
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| import * as cdk from '@aws-cdk/core'; | ||
| import * as es from '@aws-cdk/aws-elasticsearch'; | ||
| import * as iam from '@aws-cdk/aws-iam'; | ||
| import * as opensearch from '@aws-cdk/aws-opensearchservice'; | ||
|
|
||
| declare const role: iam.IRole; | ||
| declare const elasticsearchVersion: es.ElasticsearchVersion; | ||
| declare const openSearchVersion: opensearch.EngineVersion; | ||
|
|
||
| class Fixture extends cdk.Construct { | ||
| constructor(scope: cdk.Construct, id: string) { | ||
| super(scope, id); | ||
|
|
||
| /// here | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| const baseConfig = require('cdk-build-tools/config/eslintrc'); | ||
| baseConfig.parserOptions.project = __dirname + '/tsconfig.json'; | ||
| module.exports = baseConfig; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| *.js | ||
| *.js.map | ||
| *.d.ts | ||
| tsconfig.json | ||
| node_modules | ||
| *.generated.ts | ||
| dist | ||
| .jsii | ||
|
|
||
| .LAST_BUILD | ||
| .nyc_output | ||
| coverage | ||
| .nycrc | ||
| .LAST_PACKAGE | ||
| *.snk | ||
| nyc.config.js | ||
| !.eslintrc.js | ||
| !jest.config.js | ||
| junit.xml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| # Don't include original .ts files when doing `npm pack` | ||
| *.ts | ||
| !*.d.ts | ||
| coverage | ||
| .nyc_output | ||
| *.tgz | ||
|
|
||
| dist | ||
| .LAST_PACKAGE | ||
| .LAST_BUILD | ||
| !*.js | ||
|
|
||
| # Include .jsii | ||
| !.jsii | ||
|
|
||
| *.snk | ||
|
|
||
| *.tsbuildinfo | ||
|
|
||
| tsconfig.json | ||
|
|
||
| .eslintrc.js | ||
| jest.config.js | ||
|
|
||
| # exclude cdk artifacts | ||
| **/cdk.out | ||
| junit.xml | ||
| test/ | ||
| !*.lit.ts |
Oops, something went wrong.