Namespace Amazon.CDK.AWS.Elasticsearch

Amazon OpenSearch Service Construct Library

Instead of this module, we recommend using the <a href="https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_opensearchservice-readme.html">aws-cdk-lib/aws-opensearchservice</a> module. See <a href="https://aws.amazon.com/opensearch-service/faqs/#Name_change">Amazon OpenSearch Service FAQs</a> for details. See <a href="#migrating-to-opensearch">Migrating to OpenSearch</a> for migration instructions.

Quick start

Create a development cluster by simply specifying the version:

var devDomain = new Domain(this, "Domain", new DomainProps {
    Version = ElasticsearchVersion.V7_1
});

To perform version upgrades without replacing the entire domain, specify the enableVersionUpgrade property.

var devDomain = new Domain(this, "Domain", new DomainProps {
    Version = ElasticsearchVersion.V7_10,
    EnableVersionUpgrade = true
});

Create a production grade cluster by also specifying things like capacity and az distribution

var prodDomain = new Domain(this, "Domain", new DomainProps {
    Version = ElasticsearchVersion.V7_1,
    Capacity = new CapacityConfig {
        MasterNodes = 5,
        DataNodes = 20
    },
    Ebs = new EbsOptions {
        VolumeSize = 20
    },
    ZoneAwareness = new ZoneAwarenessConfig {
        AvailabilityZoneCount = 3
    },
    Logging = new LoggingOptions {
        SlowSearchLogEnabled = true,
        AppLogEnabled = true,
        SlowIndexLogEnabled = true
    }
});

This creates an Elasticsearch 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 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:

Before you can proceed, you must enable a service-linked role to give Amazon ES...

To resolve this, you need to create the SLR. We recommend using the AWS CLI:

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:

var slr = new CfnServiceLinkedRole(this, "ElasticSLR", new CfnServiceLinkedRoleProps {
    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:

var domainEndpoint = "https://my-domain-jcjotrt6f7otem4sqcwbch3c4u.us-east-1.es.amazonaws.com";
var domain = Domain.FromDomainEndpoint(this, "ImportedDomain", domainEndpoint);

Permissions

IAM

Helper methods also exist for managing access to the domain.

Function fn;
Domain 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:

var domain = new Domain(this, "Domain", new DomainProps {
    Version = ElasticsearchVersion.V7_4,
    Ebs = new EbsOptions {
        VolumeSize = 100,
        VolumeType = EbsDeviceVolumeType.GENERAL_PURPOSE_SSD
    },
    NodeToNodeEncryption = true,
    EncryptionAtRest = new EncryptionAtRestOptions {
        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

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.

See <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html">Launching your Amazon OpenSearch Service domains within a VPC</a> for more details.

var vpc = new Vpc(this, "Vpc");
var domainProps = new DomainProps {
    Version = ElasticsearchVersion.V7_1,
    RemovalPolicy = RemovalPolicy.DESTROY,
    Vpc = vpc,
    // must be enabled since our VPC contains multiple private subnets.
    ZoneAwareness = new ZoneAwarenessConfig {
        Enabled = true
    },
    Capacity = new CapacityConfig {
        // must be an even number since the default az count is 2.
        DataNodes = 2
    }
};
new 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:

Domain domain;

var freeStorageSpace = domain.MetricFreeStorageSpace();
var masterSysMemoryUtilization = domain.Metric("MasterSysMemoryUtilization");

This module is part of the AWS Cloud Development Kit 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.

var domain = new Domain(this, "Domain", new DomainProps {
    Version = ElasticsearchVersion.V7_1,
    EnforceHttps = true,
    NodeToNodeEncryption = true,
    EncryptionAtRest = new EncryptionAtRestOptions {
        Enabled = true
    },
    FineGrainedAccessControl = new AdvancedSecurityOptions {
        MasterUserName = "master-user"
    }
});

var 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 anonymous 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 <domain id>MasterUser.

var domain = new Domain(this, "Domain", new DomainProps {
    Version = ElasticsearchVersion.V7_1,
    UseUnsignedBasicAuth = true
});

var 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:

var domain = new Domain(this, "Domain", new DomainProps {
    Version = ElasticsearchVersion.V7_1,
    AccessPolicies = new [] {
        new PolicyStatement(new PolicyStatementProps {
            Actions = new [] { "es:*ESHttpPost", "es:ESHttpPut*" },
            Effect = Effect.ALLOW,
            Principals = new [] { new AccountPrincipal("123456789012") },
            Resources = new [] { "*" }
        }) }
});

For more complex use-cases, for example, to set the domain up to receive data from a cross-account Kinesis Firehose the addAccessPolicies helper method allows for policies that include the explicit domain ARN.

var domain = new Domain(this, "Domain", new DomainProps {
    Version = ElasticsearchVersion.V7_1
});

domain.AddAccessPolicies(
new PolicyStatement(new PolicyStatementProps {
    Actions = new [] { "es:ESHttpPost", "es:ESHttpPut" },
    Effect = Effect.ALLOW,
    Principals = new [] { new AccountPrincipal("123456789012") },
    Resources = new [] { domain.DomainArn, $"{domain.domainArn}/*" }
}),
new PolicyStatement(new PolicyStatementProps {
    Actions = new [] { "es:ESHttpGet" },
    Effect = Effect.ALLOW,
    Principals = new [] { new AccountPrincipal("123456789012") },
    Resources = new [] { $"{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.

var domain = new Domain(this, "Domain", new DomainProps {
    Version = ElasticsearchVersion.V7_1,
    EnforceHttps = true,
    NodeToNodeEncryption = true,
    EncryptionAtRest = new EncryptionAtRestOptions {
        Enabled = true
    },
    FineGrainedAccessControl = new AdvancedSecurityOptions {
        MasterUserName = "master-user"
    },
    Logging = new LoggingOptions {
        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.

var domain = new Domain(this, "Domain", new DomainProps {
    Version = ElasticsearchVersion.V7_10,
    Capacity = new CapacityConfig {
        MasterNodes = 2,
        WarmNodes = 2,
        WarmInstanceType = "ultrawarm1.medium.elasticsearch"
    }
});

Custom endpoint

Custom endpoints can be configured to reach the ES domain under a custom domain name.

new Domain(this, "Domain", new DomainProps {
    Version = ElasticsearchVersion.V7_7,
    CustomEndpoint = new CustomEndpointOptions {
        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 cluster settings can used to configure additional options.

new Domain(this, "Domain", new DomainProps {
    Version = ElasticsearchVersion.V7_7,
    AdvancedOptions = new Dictionary<string, string> {
        { "rest.action.multi.allow_explicit_index", "false" },
        { "indices.fielddata.cache.size", "25" },
        { "indices.query.bool.max_clause_count", "2048" }
    }
});

Migrating to OpenSearch

To migrate from this module (aws-cdk-lib/aws-elasticsearch) to the new aws-cdk-lib/aws-opensearchservice module, you must modify your CDK application to refer to the new module (including some associated changes) and then perform a CloudFormation resource deletion/import.

Necessary CDK Modifications

Make the following modifications to your CDK application to migrate to the aws-cdk-lib/aws-opensearchservice module.

CloudFormation Migration

Follow these steps to migrate your application without data loss:

Classes

AdvancedSecurityOptions	(deprecated) Specifies options for fine-grained access control.
CapacityConfig	(deprecated) Configures the capacity of the cluster such as the instance type and the number of instances.
CfnDomain	The AWS::Elasticsearch::Domain resource creates an Amazon OpenSearch Service domain.
CfnDomain.AdvancedSecurityOptionsInputProperty	Specifies options for fine-grained access control.
CfnDomain.CognitoOptionsProperty	Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
CfnDomain.ColdStorageOptionsProperty	Specifies options for cold storage. For more information, see Cold storage for Amazon Elasticsearch Service .
CfnDomain.DomainEndpointOptionsProperty	Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint.
CfnDomain.EBSOptionsProperty	The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.
CfnDomain.ElasticsearchClusterConfigProperty	The cluster configuration for the OpenSearch Service domain.
CfnDomain.EncryptionAtRestOptionsProperty	Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.
CfnDomain.LogPublishingOptionProperty	The `AWS::Elasticsearch::Domain` resource is being replaced by the AWS::OpenSearchService::Domain resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see New resource types in the Amazon OpenSearch Service Developer Guide .
CfnDomain.MasterUserOptionsProperty	Specifies information about the master user. Required if you enabled the internal user database.
CfnDomain.NodeToNodeEncryptionOptionsProperty	Specifies whether node-to-node encryption is enabled.
CfnDomain.SnapshotOptionsProperty	The `AWS::Elasticsearch::Domain` resource is being replaced by the AWS::OpenSearchService::Domain resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see New resource types in the Amazon OpenSearch Service Developer Guide .
CfnDomain.VPCOptionsProperty	The virtual private cloud (VPC) configuration for the OpenSearch Service domain.
CfnDomain.ZoneAwarenessConfigProperty	Specifies zone awareness configuration options. Only use if `ZoneAwarenessEnabled` is `true` .
CfnDomainProps	Properties for defining a `CfnDomain`.
CognitoOptions	(deprecated) Configures Amazon ES to use Amazon Cognito authentication for Kibana.
CustomEndpointOptions	(deprecated) Configures a custom domain endpoint for the ES domain.
Domain	(deprecated) Provides an Elasticsearch domain.
DomainAttributes	(deprecated) Reference to an Elasticsearch domain.
DomainProps	(deprecated) Properties for an AWS Elasticsearch Domain.
EbsOptions	(deprecated) The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the Amazon ES domain.
ElasticsearchVersion	Elasticsearch version.
EncryptionAtRestOptions	(deprecated) Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service (KMS) key to use.
LoggingOptions	(deprecated) Configures log settings for the domain.
TLSSecurityPolicy	(deprecated) The minimum TLS version required for traffic to the domain.
ZoneAwarenessConfig	(deprecated) Specifies zone awareness configuration options.

Interfaces

CfnDomain.IAdvancedSecurityOptionsInputProperty	Specifies options for fine-grained access control.
CfnDomain.ICognitoOptionsProperty	Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
CfnDomain.IColdStorageOptionsProperty	Specifies options for cold storage. For more information, see Cold storage for Amazon Elasticsearch Service .
CfnDomain.IDomainEndpointOptionsProperty	Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint.
CfnDomain.IEBSOptionsProperty	The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.
CfnDomain.IElasticsearchClusterConfigProperty	The cluster configuration for the OpenSearch Service domain.
CfnDomain.IEncryptionAtRestOptionsProperty	Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.
CfnDomain.ILogPublishingOptionProperty	The `AWS::Elasticsearch::Domain` resource is being replaced by the AWS::OpenSearchService::Domain resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see New resource types in the Amazon OpenSearch Service Developer Guide .
CfnDomain.IMasterUserOptionsProperty	Specifies information about the master user. Required if you enabled the internal user database.
CfnDomain.INodeToNodeEncryptionOptionsProperty	Specifies whether node-to-node encryption is enabled.
CfnDomain.ISnapshotOptionsProperty	The `AWS::Elasticsearch::Domain` resource is being replaced by the AWS::OpenSearchService::Domain resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see New resource types in the Amazon OpenSearch Service Developer Guide .
CfnDomain.IVPCOptionsProperty	The virtual private cloud (VPC) configuration for the OpenSearch Service domain.
CfnDomain.IZoneAwarenessConfigProperty	Specifies zone awareness configuration options. Only use if `ZoneAwarenessEnabled` is `true` .
IAdvancedSecurityOptions	(deprecated) Specifies options for fine-grained access control.
ICapacityConfig	(deprecated) Configures the capacity of the cluster such as the instance type and the number of instances.
ICfnDomainProps	Properties for defining a `CfnDomain`.
ICognitoOptions	(deprecated) Configures Amazon ES to use Amazon Cognito authentication for Kibana.
ICustomEndpointOptions	(deprecated) Configures a custom domain endpoint for the ES domain.
IDomain	(deprecated) An interface that represents an Elasticsearch domain - either created with the CDK, or an existing one.
IDomainAttributes	(deprecated) Reference to an Elasticsearch domain.
IDomainProps	(deprecated) Properties for an AWS Elasticsearch Domain.
IEbsOptions	(deprecated) The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the Amazon ES domain.
IEncryptionAtRestOptions	(deprecated) Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service (KMS) key to use.
ILoggingOptions	(deprecated) Configures log settings for the domain.
IZoneAwarenessConfig	(deprecated) Specifies zone awareness configuration options.