From c8b823ce83ba787ce2f24073657c388b2b294956 Mon Sep 17 00:00:00 2001 From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com> Date: Wed, 28 Dec 2022 19:01:38 +0000 Subject: [PATCH] docs(elasticsearch): remove elasticsearch service references (backport #23476) (#23485) This is an automatic backport of pull request #23476 done by [Mergify](https://mergify.com). ---
Mergify commands and options
More conditions and actions can be found in the [documentation](https://docs.mergify.com/). You can also trigger Mergify actions by commenting on this pull request: - `@Mergifyio refresh` will re-evaluate the rules - `@Mergifyio rebase` will rebase this PR on its base branch - `@Mergifyio update` will merge the base branch into this PR - `@Mergifyio backport ` will backport this PR on `` branch Additionally, on Mergify [dashboard](https://dashboard.mergify.com/) you can: - look at your merge queues - generate the Mergify configuration with the config editor. Finally, you can contact us on https://mergify.com
--- packages/@aws-cdk/aws-elasticsearch/README.md | 10 +++++----- tools/@aws-cdk/pkglint/lib/rules.ts | 3 ++- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/packages/@aws-cdk/aws-elasticsearch/README.md b/packages/@aws-cdk/aws-elasticsearch/README.md index 41f32d46e3e97..2b4cb2e69b47f 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 simlar 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', { diff --git a/tools/@aws-cdk/pkglint/lib/rules.ts b/tools/@aws-cdk/pkglint/lib/rules.ts index 607899f7dee2f..c16d995bf87b7 100644 --- a/tools/@aws-cdk/pkglint/lib/rules.ts +++ b/tools/@aws-cdk/pkglint/lib/rules.ts @@ -322,7 +322,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];