# @aws-cdk/aws-opensearchservice > The CDK Construct Library for AWS::OpenSearchService Latest version **1.204.0** (published 2023-06-19) · Apache-2.0 license · 0 weekly downloads > **Deprecated.** This package is deprecated. ## Install ```sh npm install @aws-cdk/aws-opensearchservice pnpm add @aws-cdk/aws-opensearchservice yarn add @aws-cdk/aws-opensearchservice bun add @aws-cdk/aws-opensearchservice ``` ## Health **Score 10/100 (F)** — status: deprecated. Negative: deprecated. ## Facts | | | |---|---| | Version | 1.204.0 | | Published | 2023-06-19 | | First published | 2021-09-17 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | bundled | | Module format | CommonJS | | Node | >= 14.15.0 | | Dependencies | 11 | | Unpacked size | 1.1 MB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 12907 | | Author | Amazon Web Services | | Maintainers | romainmuller, amzn-oss, rix0rrr, aws-cdk-team | | Keywords | aws, cdk, constructs, AWS::OpenSearchService, aws-opensearchservice, opensearchservice | ## Links - npm: https://www.npmjs.com/package/@aws-cdk/aws-opensearchservice - Repository: https://github.com/aws/aws-cdk - Issues: https://github.com/aws/aws-cdk/issues - npm.io page: https://npm.io/package/@aws-cdk/aws-opensearchservice ## Dependencies (11) - [constructs](https://npm.io/package/constructs.md) ^3.3.69 - [@aws-cdk/core](https://npm.io/package/@aws-cdk/core.md) 1.204.0 - [@aws-cdk/aws-ec2](https://npm.io/package/@aws-cdk/aws-ec2.md) 1.204.0 - [@aws-cdk/aws-iam](https://npm.io/package/@aws-cdk/aws-iam.md) 1.204.0 - [@aws-cdk/aws-kms](https://npm.io/package/@aws-cdk/aws-kms.md) 1.204.0 - [@aws-cdk/aws-logs](https://npm.io/package/@aws-cdk/aws-logs.md) 1.204.0 - [@aws-cdk/aws-route53](https://npm.io/package/@aws-cdk/aws-route53.md) 1.204.0 - [@aws-cdk/aws-cloudwatch](https://npm.io/package/@aws-cdk/aws-cloudwatch.md) 1.204.0 - [@aws-cdk/custom-resources](https://npm.io/package/@aws-cdk/custom-resources.md) 1.204.0 - [@aws-cdk/aws-secretsmanager](https://npm.io/package/@aws-cdk/aws-secretsmanager.md) 1.204.0 - [@aws-cdk/aws-certificatemanager](https://npm.io/package/@aws-cdk/aws-certificatemanager.md) 1.204.0 ## Alternatives - [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads - [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads - [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads - [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads - [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads ## Recent versions - 1.204.0 (latest) — 2023-06-19 - 1.203.0 — 2023-05-31 - 1.202.0 — 2023-05-22 - 1.201.0 — 2023-05-10 - 1.200.0 — 2023-04-26 - 1.199.0 — 2023-04-20 - 1.198.1 — 2023-03-31 - 1.198.0 — 2023-03-22 - 1.197.0 — 2023-03-14 - 1.196.0 — 2023-03-08 - 1.195.0 — 2023-03-02 - 1.194.0 — 2023-02-21 - 1.193.0 — 2023-02-15 - 1.192.0 — 2023-02-09 - 1.191.0 — 2023-01-31 - … 78 more at https://npm.io/package/@aws-cdk/aws-opensearchservice/versions ## README # Amazon OpenSearch Service Construct Library --- ![End-of-Support](https://img.shields.io/badge/End--of--Support-critical.svg?style=for-the-badge) > AWS CDK v1 has reached End-of-Support on 2023-06-01. > This package is no longer being updated, and users should migrate to AWS CDK v2. > > For more information on how to migrate, see the [_Migrating to AWS CDK v2_ guide][doc]. > > [doc]: https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html --- Features | Stability -----------------------------------|---------------------------------------------------------------- CFN Resources | ![Stable](https://img.shields.io/badge/stable-success.svg?style=for-the-badge) Higher level constructs for Domain | ![Stable](https://img.shields.io/badge/stable-success.svg?style=for-the-badge) > **CFN Resources:** All classes with the `Cfn` prefix in this module ([CFN Resources]) are always > stable and safe to use. > > [CFN Resources]: https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib > **Stable:** Higher level constructs in this module that are marked stable will not undergo any > breaking changes. They will strictly follow the [Semantic Versioning](https://semver.org/) model. --- See [Migrating to OpenSearch](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-elasticsearch-readme.html#migrating-to-opensearch) for migration instructions from `@aws-cdk/aws-elasticsearch` to this module, `@aws-cdk/aws-opensearchservice`. ## Quick start Create a development cluster by simply specifying the version: ```ts const devDomain = new opensearch.Domain(this, 'Domain', { version: opensearch.EngineVersion.OPENSEARCH_1_0, }); ``` To perform version upgrades without replacing the entire domain, specify the `enableVersionUpgrade` property. ```ts const devDomain = new opensearch.Domain(this, 'Domain', { version: opensearch.EngineVersion.OPENSEARCH_1_0, enableVersionUpgrade: true, // defaults to false }); ``` Create a production grade cluster by also specifying things like capacity and az distribution ```ts const prodDomain = new opensearch.Domain(this, 'Domain', { version: opensearch.EngineVersion.OPENSEARCH_1_0, capacity: { masterNodes: 5, dataNodes: 20, }, ebs: { volumeSize: 20, }, zoneAwareness: { availabilityZoneCount: 3, }, logging: { slowSearchLogEnabled: true, appLogEnabled: true, slowIndexLogEnabled: true, }, }); ``` This creates an Amazon OpenSearch Service cluster and automatically sets up log groups for 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/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: ```console Before you can proceed, you must enable a service-linked role to give Amazon OpenSearch Service... ``` To resolve this, you need to [create](https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html#create-service-linked-role) the SLR. We recommend using the AWS CLI: ```console aws iam create-service-linked-role --aws-service-name es.amazonaws.com ``` You can also create it using the CDK, **but note that only the first application deploying this will succeed**: ```ts const slr = new iam.CfnServiceLinkedRole(this, 'Service Linked Role', { awsServiceName: 'es.amazonaws.com', }); ``` ## Importing existing domains To import an existing domain into your CDK application, use the `Domain.fromDomainEndpoint` factory method. This method accepts a domain endpoint of an already existing domain: ```ts const domainEndpoint = 'https://my-domain-jcjotrt6f7otem4sqcwbch3c4u.us-east-1.es.amazonaws.com'; const domain = opensearch.Domain.fromDomainEndpoint(this, 'ImportedDomain', domainEndpoint); ``` ## Permissions ### IAM Helper methods also exist for managing access to the domain. ```ts declare const fn: lambda.Function; declare const domain: opensearch.Domain; // Grant write access to the app-search index domain.grantIndexWrite('app-search', fn); // Grant read access to the 'app-search/_search' path domain.grantPathRead('app-search/_search', fn); ``` ## Encryption The domain can also be created with encryption enabled: ```ts const domain = new opensearch.Domain(this, 'Domain', { version: opensearch.EngineVersion.OPENSEARCH_1_0, ebs: { volumeSize: 100, volumeType: ec2.EbsDeviceVolumeType.GENERAL_PURPOSE_SSD, }, nodeToNodeEncryption: true, encryptionAtRest: { enabled: true, }, }); ``` This sets up the domain with node to node encryption and encryption at rest. You can also choose to supply your own KMS key to use for encryption at rest. ## VPC Support Domains can be placed inside a VPC, providing a secure communication between Amazon OpenSearch Service and other services within the VPC without the need for an internet gateway, NAT device, or VPN connection. > Visit [VPC Support for Amazon OpenSearch Service Domains](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html) for more details. ```ts const vpc = new ec2.Vpc(this, 'Vpc'); const domainProps: opensearch.DomainProps = { version: opensearch.EngineVersion.OPENSEARCH_1_0, removalPolicy: RemovalPolicy.DESTROY, vpc, // must be enabled since our VPC contains multiple private subnets. zoneAwareness: { enabled: true, }, capacity: { // must be an even number since the default az count is 2. dataNodes: 2, }, }; new opensearch.Domain(this, 'Domain', domainProps); ``` In addition, you can use the `vpcSubnets` property to control which specific subnets will be used, and the `securityGroups` property to control which security groups will be attached to the domain. By default, CDK will select all *private* subnets in the VPC, and create one dedicated security group. ## Metrics Helper methods exist to access common domain metrics for example: ```ts declare const domain: opensearch.Domain; const freeStorageSpace = domain.metricFreeStorageSpace(); const masterSysMemoryUtilization = domain.metric('MasterSysMemoryUtilization'); ``` This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project. ## Fine grained access control The domain can also be created with a master user configured. The password can be supplied or dynamically created if not supplied. ```ts const domain = new opensearch.Domain(this, 'Domain', { version: opensearch.EngineVersion.OPENSEARCH_1_0, enforceHttps: true, nodeToNodeEncryption: true, encryptionAtRest: { enabled: true, }, fineGrainedAccessControl: { masterUserName: 'master-user', }, }); const masterUserPassword = domain.masterUserPassword; ``` ## Using unsigned basic auth For convenience, the domain can be configured to allow unsigned HTTP requests that use basic auth. Unless the domain is configured to be part of a VPC this means anyone can access the domain using the configured master username and password. To enable unsigned basic auth access the domain is configured with an access policy that allows anyonmous requests, HTTPS required, node to node encryption, encryption at rest and fine grained access control. If the above settings are not set they will be configured as part of enabling unsigned basic auth. If they are set with conflicting values, an error will be thrown. If no master user is configured a default master user is created with the username `admin`. If no password is configured a default master user password is created and stored in the AWS Secrets Manager as secret. The secret has the prefix `MasterUser`. ```ts const domain = new opensearch.Domain(this, 'Domain', { version: opensearch.EngineVersion.OPENSEARCH_1_0, useUnsignedBasicAuth: true, }); const masterUserPassword = domain.masterUserPassword; ``` ## Custom access policies If the domain requires custom access control it can be configured either as a constructor property, or later by means of a helper method. For simple permissions the `accessPolicies` constructor may be sufficient: ```ts const domain = new opensearch.Domain(this, 'Domain', { version: opensearch.EngineVersion.OPENSEARCH_1_0, accessPolicies: [ new iam.PolicyStatement({ actions: ['es:*ESHttpPost', 'es:ESHttpPut*'], effect: iam.Effect.ALLOW, principals: [new iam.AccountPrincipal('123456789012')], resources: ['*'], }), ] }); ``` For more complex use-cases, for example, to set the domain up to receive data from a [cross-account Kinesis Firehose](https://aws.amazon.com/premiumsupport/knowledge-center/kinesis-firehose-cross-account-streaming/) the `addAccessPolicies` helper method allows for policies that include the explicit domain ARN. ```ts const domain = new opensearch.Domain(this, 'Domain', { version: opensearch.EngineVersion.OPENSEARCH_1_0, }); domain.addAccessPolicies( new iam.PolicyStatement({ actions: ['es:ESHttpPost', 'es:ESHttpPut'], effect: iam.Effect.ALLOW, principals: [new iam.AccountPrincipal('123456789012')], resources: [domain.domainArn, `${domain.domainArn}/*`], }), new iam.PolicyStatement({ actions: ['es:ESHttpGet'], effect: iam.Effect.ALLOW, principals: [new iam.AccountPrincipal('123456789012')], resources: [ `${domain.domainArn}/_all/_settings`, `${domain.domainArn}/_cluster/stats`, `${domain.domainArn}/index-name*/_mapping/type-name`, `${domain.domainArn}/roletest*/_mapping/roletest`, `${domain.domainArn}/_nodes`, `${domain.domainArn}/_nodes/stats`, `${domain.domainArn}/_nodes/*/stats`, `${domain.domainArn}/_stats`, `${domain.domainArn}/index-name*/_stats`, `${domain.domainArn}/roletest*/_stat`, ], }), ); ``` ## Audit logs Audit logs can be enabled for a domain, but only when fine grained access control is enabled. ```ts const domain = new opensearch.Domain(this, 'Domain', { version: opensearch.EngineVersion.OPENSEARCH_1_0, enforceHttps: true, nodeToNodeEncryption: true, encryptionAtRest: { enabled: true, }, fineGrainedAccessControl: { masterUserName: 'master-user', }, logging: { auditLogEnabled: true, slowSearchLogEnabled: true, appLogEnabled: true, slowIndexLogEnabled: true, }, }); ``` ## UltraWarm UltraWarm nodes can be enabled to provide a cost-effective way to store large amounts of read-only data. ```ts const domain = new opensearch.Domain(this, 'Domain', { version: opensearch.EngineVersion.OPENSEARCH_1_0, capacity: { masterNodes: 2, warmNodes: 2, warmInstanceType: 'ultrawarm1.medium.search', }, }); ``` ## Custom endpoint Custom endpoints can be configured to reach the domain under a custom domain name. ```ts new opensearch.Domain(this, 'Domain', { version: opensearch.EngineVersion.OPENSEARCH_1_0, customEndpoint: { domainName: 'search.example.com', }, }); ``` It is also possible to specify a custom certificate instead of the auto-generated one. Additionally, an automatic CNAME-Record is created if a hosted zone is provided for the custom endpoint ## Advanced options [Advanced options](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options) can used to configure additional options. ```ts new opensearch.Domain(this, 'Domain', { version: opensearch.EngineVersion.OPENSEARCH_1_0, advancedOptions: { 'rest.action.multi.allow_explicit_index': 'false', 'indices.fielddata.cache.size': '25', 'indices.query.bool.max_clause_count': '2048', }, }); ``` --- _Source: https://npm.io/package/@aws-cdk/aws-opensearchservice · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._