Skip to content

Commit

Permalink
docs(elasticsearch): remove elasticsearch service references (backport
Browse files Browse the repository at this point in the history
…#23476) (#23485)

This is an automatic backport of pull request #23476 done by [Mergify](https://mergify.com).


---


<details>
<summary>Mergify commands and options</summary>

<br />

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 <destination>` will backport this PR on `<destination>` 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
</details>
  • Loading branch information
mergify[bot] authored Dec 28, 2022
1 parent 9bd8f2c commit c8b823c
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
10 changes: 5 additions & 5 deletions packages/@aws-cdk/aws-elasticsearch/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Amazon Elasticsearch Service Construct Library
# Amazon OpenSearch Service (legacy Elasticsearch) Construct Library
<!--BEGIN STABILITY BANNER-->

---
Expand Down Expand Up @@ -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:

Expand Down Expand Up @@ -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');
Expand Down Expand Up @@ -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', {
Expand Down Expand Up @@ -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', {
Expand Down
3 changes: 2 additions & 1 deletion tools/@aws-cdk/pkglint/lib/rules.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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];
Expand Down

0 comments on commit c8b823c

Please sign in to comment.