From 9ca41bc00c323effb781ff7ce7d2d2ded93f3afc Mon Sep 17 00:00:00 2001 From: Liz Snyder <31932630+lizsnyder@users.noreply.github.com> Date: Tue, 27 Dec 2022 10:07:14 -0800 Subject: [PATCH 1/2] Remove "Elasticsearch Service" references --- packages/@aws-cdk/aws-elasticsearch/README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/packages/@aws-cdk/aws-elasticsearch/README.md b/packages/@aws-cdk/aws-elasticsearch/README.md index 6d979176d8fff..b88e2cb1b880e 100644 --- a/packages/@aws-cdk/aws-elasticsearch/README.md +++ b/packages/@aws-cdk/aws-elasticsearch/README.md @@ -1,4 +1,4 @@ -# Amazon Elasticsearch Service Construct Library +# Amazon OpenSearch Service (legacy Elasticsearch) Construct Library --- @@ -60,7 +60,7 @@ logging the domain logs and slow search logs. ## A note about SLR -Some cluster configurations (e.g VPC access) require the existence of the [`AWSServiceRoleForAmazonElasticsearchService`](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/slr-es.html) Service-Linked Role. +Some cluster configurations (e.g VPC access) require the existence of the [`AWSServiceRoleForAmazonElasticsearchService`](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/slr.html) service-linked role. When performing such operations via the AWS Console, this SLR is created automatically when needed. However, this is not the behavior when using CloudFormation. If an SLR is needed, but doesn't exist, you will encounter a failure message similar to: @@ -135,7 +135,7 @@ rest. Elasticsearch domains can be placed inside a VPC, providing a secure communication between Amazon ES and other services within the VPC without the need for an internet gateway, NAT device, or VPN connection. -> Visit [VPC Support for Amazon Elasticsearch Service Domains](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html) for more details. +> See [Launching your Amazon OpenSearch Service domains within a VPC](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html) for more details. ```ts const vpc = new ec2.Vpc(this, 'Vpc'); @@ -281,7 +281,7 @@ domain.addAccessPolicies( ## Audit logs -Audit logs can be enabled for a domain, but only when fine grained access control is enabled. +Audit logs can be enabled for a domain, but only when fine-grained access control is enabled. ```ts const domain = new es.Domain(this, 'Domain', { @@ -337,7 +337,7 @@ Additionally, an automatic CNAME-Record is created if a hosted zone is provided ## Advanced options -[Advanced options](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options) can used to configure additional options. +[Advanced cluster settings](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options) can used to configure additional options. ```ts new es.Domain(this, 'Domain', { From c1f0b289bd79a42c653aef1096404b6fd33b58fb Mon Sep 17 00:00:00 2001 From: Kaizen Conroy Date: Wed, 28 Dec 2022 12:36:50 -0500 Subject: [PATCH 2/2] exempt from readme linter rule, i think --- tools/@aws-cdk/pkglint/lib/rules.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/tools/@aws-cdk/pkglint/lib/rules.ts b/tools/@aws-cdk/pkglint/lib/rules.ts index 5a921a7d27dbc..9f257954fcabc 100644 --- a/tools/@aws-cdk/pkglint/lib/rules.ts +++ b/tools/@aws-cdk/pkglint/lib/rules.ts @@ -276,7 +276,8 @@ export class ReadmeFile extends ValidationRule { if (!scopes) { return; } - if (pkg.packageName === '@aws-cdk/core') { + // elasticsearch is renamed to opensearch service, so its readme does not follow these rules + if (pkg.packageName === '@aws-cdk/core' || pkg.packageName === '@aws-cdk/aws-elasticsearch') { return; } const scope: string = typeof scopes === 'string' ? scopes : scopes[0];