Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(elasticsearch): remove elasticsearch service references #23476

Merged
merged 3 commits into from
Dec 28, 2022
Merged

docs(elasticsearch): remove elasticsearch service references #23476

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9ca41bc
Remove "Elasticsearch Service" references
lizsnyder Dec 27, 2022
a441da5
Merge branch 'main' into patch-1
lizsnyder Dec 28, 2022
c1f0b28
exempt from readme linter rule, i think
kaizencc Dec 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions packages/@aws-cdk/aws-elasticsearch/README.md
View file
Open in desktop
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 similar 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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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];
Expand Down