Skip to content

Commit b195465

Browse files
authored
docs(elasticsearch): remove elasticsearch service references (#23476)
---- Elastic has requested that we remove all "Amazon Elasticsearch Service" references from our docs for legal reasons. ### All Submissions: * [X] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent 46dbfa2 commit b195465

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

packages/@aws-cdk/aws-elasticsearch/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Amazon Elasticsearch Service Construct Library
1+
# Amazon OpenSearch Service (legacy Elasticsearch) Construct Library
22
<!--BEGIN STABILITY BANNER-->
33

44
---
@@ -60,7 +60,7 @@ logging the domain logs and slow search logs.
6060

6161
## A note about SLR
6262

63-
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.
63+
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.
6464

6565
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:
6666

@@ -135,7 +135,7 @@ rest.
135135

136136
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.
137137

138-
> Visit [VPC Support for Amazon Elasticsearch Service Domains](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html) for more details.
138+
> See [Launching your Amazon OpenSearch Service domains within a VPC](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html) for more details.
139139
140140
```ts
141141
const vpc = new ec2.Vpc(this, 'Vpc');
@@ -281,7 +281,7 @@ domain.addAccessPolicies(
281281

282282
## Audit logs
283283

284-
Audit logs can be enabled for a domain, but only when fine grained access control is enabled.
284+
Audit logs can be enabled for a domain, but only when fine-grained access control is enabled.
285285

286286
```ts
287287
const domain = new es.Domain(this, 'Domain', {
@@ -337,7 +337,7 @@ Additionally, an automatic CNAME-Record is created if a hosted zone is provided
337337

338338
## Advanced options
339339

340-
[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.
340+
[Advanced cluster settings](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options) can used to configure additional options.
341341

342342
```ts
343343
new es.Domain(this, 'Domain', {

tools/@aws-cdk/pkglint/lib/rules.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -276,7 +276,8 @@ export class ReadmeFile extends ValidationRule {
276276
if (!scopes) {
277277
return;
278278
}
279-
if (pkg.packageName === '@aws-cdk/core') {
279+
// elasticsearch is renamed to opensearch service, so its readme does not follow these rules
280+
if (pkg.packageName === '@aws-cdk/core' || pkg.packageName === '@aws-cdk/aws-elasticsearch') {
280281
return;
281282
}
282283
const scope: string = typeof scopes === 'string' ? scopes : scopes[0];

0 commit comments

Comments
 (0)