software.amazon.awscdk.services.elasticsearch

Interface IDomain

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IDependable, IResource, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IDomain.Jsii$Default

All Known Implementing Classes:

Domain, IDomain.Jsii$Proxy

Deprecated.

use opensearchservice module instead

@Generated(value="jsii-pacmak/1.57.0 (build f614666)",
           date="2022-04-22T09:30:47.746Z")
 @Stability(value=Deprecated)
 @Deprecated
public interface IDomain
extends software.amazon.jsii.JsiiSerializable, IResource

(deprecated) An interface that represents an Elasticsearch domain - either created with the CDK, or an existing one.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IDomain.Jsii$Default Deprecated. Internal default implementation for IDomain.
static class	IDomain.Jsii$Proxy Deprecated. A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method and Description
String	getDomainArn() Deprecated. use opensearchservice module instead
String	getDomainEndpoint() Deprecated. use opensearchservice module instead
String	getDomainName() Deprecated. use opensearchservice module instead
Grant	grantIndexRead(String index, IGrantable identity) Deprecated. use opensearchservice module instead
Grant	grantIndexReadWrite(String index, IGrantable identity) Deprecated. use opensearchservice module instead
Grant	grantIndexWrite(String index, IGrantable identity) Deprecated. use opensearchservice module instead
Grant	grantPathRead(String path, IGrantable identity) Deprecated. use opensearchservice module instead
Grant	grantPathReadWrite(String path, IGrantable identity) Deprecated. use opensearchservice module instead
Grant	grantPathWrite(String path, IGrantable identity) Deprecated. use opensearchservice module instead
Grant	grantRead(IGrantable identity) Deprecated. use opensearchservice module instead
Grant	grantReadWrite(IGrantable identity) Deprecated. use opensearchservice module instead
Grant	grantWrite(IGrantable identity) Deprecated. use opensearchservice module instead
Metric	metric(String metricName) Deprecated. use opensearchservice module instead
Metric	metric(String metricName, MetricOptions props) Deprecated. use opensearchservice module instead
Metric	metricAutomatedSnapshotFailure() Deprecated. use opensearchservice module instead
Metric	metricAutomatedSnapshotFailure(MetricOptions props) Deprecated. use opensearchservice module instead
Metric	metricClusterIndexWritesBlocked() Deprecated. use opensearchservice module instead
Metric	metricClusterIndexWritesBlocked(MetricOptions props) Deprecated. use opensearchservice module instead
Metric	metricClusterStatusRed() Deprecated. use opensearchservice module instead
Metric	metricClusterStatusRed(MetricOptions props) Deprecated. use opensearchservice module instead
Metric	metricClusterStatusYellow() Deprecated. use opensearchservice module instead
Metric	metricClusterStatusYellow(MetricOptions props) Deprecated. use opensearchservice module instead
Metric	metricCPUUtilization() Deprecated. use opensearchservice module instead
Metric	metricCPUUtilization(MetricOptions props) Deprecated. use opensearchservice module instead
Metric	metricFreeStorageSpace() Deprecated. use opensearchservice module instead
Metric	metricFreeStorageSpace(MetricOptions props) Deprecated. use opensearchservice module instead
Metric	metricIndexingLatency() Deprecated. use opensearchservice module instead
Metric	metricIndexingLatency(MetricOptions props) Deprecated. use opensearchservice module instead
Metric	metricJVMMemoryPressure() Deprecated. use opensearchservice module instead
Metric	metricJVMMemoryPressure(MetricOptions props) Deprecated. use opensearchservice module instead
Metric	metricKMSKeyError() Deprecated. use opensearchservice module instead
Metric	metricKMSKeyError(MetricOptions props) Deprecated. use opensearchservice module instead
Metric	metricKMSKeyInaccessible() Deprecated. use opensearchservice module instead
Metric	metricKMSKeyInaccessible(MetricOptions props) Deprecated. use opensearchservice module instead
Metric	metricMasterCPUUtilization() Deprecated. use opensearchservice module instead
Metric	metricMasterCPUUtilization(MetricOptions props) Deprecated. use opensearchservice module instead
Metric	metricMasterJVMMemoryPressure() Deprecated. use opensearchservice module instead
Metric	metricMasterJVMMemoryPressure(MetricOptions props) Deprecated. use opensearchservice module instead
Metric	metricNodes() Deprecated. use opensearchservice module instead
Metric	metricNodes(MetricOptions props) Deprecated. use opensearchservice module instead
Metric	metricSearchableDocuments() Deprecated. use opensearchservice module instead
Metric	metricSearchableDocuments(MetricOptions props) Deprecated. use opensearchservice module instead
Metric	metricSearchLatency() Deprecated. use opensearchservice module instead
Metric	metricSearchLatency(MetricOptions props) Deprecated. use opensearchservice module instead

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDomainArn

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
String getDomainArn()

Deprecated. use opensearchservice module instead

(deprecated) Arn of the Elasticsearch domain.

getDomainEndpoint

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
String getDomainEndpoint()

Deprecated. use opensearchservice module instead

(deprecated) Endpoint of the Elasticsearch domain.

getDomainName

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
String getDomainName()

Deprecated. use opensearchservice module instead

(deprecated) Domain name of the Elasticsearch domain.

grantIndexRead

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Grant grantIndexRead(@NotNull
                                                                         String index,
                                                                         @NotNull
                                                                         IGrantable identity)

Deprecated. use opensearchservice module instead

(deprecated) Grant read permissions for an index in this domain to an IAM principal (Role/Group/User).

Parameters:

index - The index to grant permissions for. This parameter is required.

identity - The principal. This parameter is required.

grantIndexReadWrite

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Grant grantIndexReadWrite(@NotNull
                                                                              String index,
                                                                              @NotNull
                                                                              IGrantable identity)

Deprecated. use opensearchservice module instead

(deprecated) Grant read/write permissions for an index in this domain to an IAM principal (Role/Group/User).

Parameters:

index - The index to grant permissions for. This parameter is required.

identity - The principal. This parameter is required.

grantIndexWrite

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Grant grantIndexWrite(@NotNull
                                                                          String index,
                                                                          @NotNull
                                                                          IGrantable identity)

Deprecated. use opensearchservice module instead

(deprecated) Grant write permissions for an index in this domain to an IAM principal (Role/Group/User).

Parameters:

index - The index to grant permissions for. This parameter is required.

identity - The principal. This parameter is required.

grantPathRead

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Grant grantPathRead(@NotNull
                                                                        String path,
                                                                        @NotNull
                                                                        IGrantable identity)

Deprecated. use opensearchservice module instead

(deprecated) Grant read permissions for a specific path in this domain to an IAM principal (Role/Group/User).

Parameters:

path - The path to grant permissions for. This parameter is required.

identity - The principal. This parameter is required.

grantPathReadWrite

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Grant grantPathReadWrite(@NotNull
                                                                             String path,
                                                                             @NotNull
                                                                             IGrantable identity)

Deprecated. use opensearchservice module instead

(deprecated) Grant read/write permissions for a specific path in this domain to an IAM principal (Role/Group/User).

Parameters:

path - The path to grant permissions for. This parameter is required.

identity - The principal. This parameter is required.

grantPathWrite

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Grant grantPathWrite(@NotNull
                                                                         String path,
                                                                         @NotNull
                                                                         IGrantable identity)

Deprecated. use opensearchservice module instead

(deprecated) Grant write permissions for a specific path in this domain to an IAM principal (Role/Group/User).

Parameters:

path - The path to grant permissions for. This parameter is required.

identity - The principal. This parameter is required.

grantRead

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Grant grantRead(@NotNull
                                                                    IGrantable identity)

Deprecated. use opensearchservice module instead

(deprecated) Grant read permissions for this domain and its contents to an IAM principal (Role/Group/User).

Parameters:

identity - The principal. This parameter is required.

grantReadWrite

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Grant grantReadWrite(@NotNull
                                                                         IGrantable identity)

Deprecated. use opensearchservice module instead

(deprecated) Grant read/write permissions for this domain and its contents to an IAM principal (Role/Group/User).

Parameters:

identity - The principal. This parameter is required.

grantWrite

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Grant grantWrite(@NotNull
                                                                     IGrantable identity)

Deprecated. use opensearchservice module instead

(deprecated) Grant write permissions for this domain and its contents to an IAM principal (Role/Group/User).

Parameters:

identity - The principal. This parameter is required.

metric

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Metric metric(@NotNull
                                                                  String metricName,
                                                                  @Nullable
                                                                  MetricOptions props)

Deprecated. use opensearchservice module instead

(deprecated) Return the given named metric for this Domain.

Parameters:

metricName - This parameter is required.

props -

metric

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Metric metric(@NotNull
                                                                  String metricName)

Deprecated. use opensearchservice module instead

(deprecated) Return the given named metric for this Domain.

Parameters:

metricName - This parameter is required.

metricAutomatedSnapshotFailure

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Metric metricAutomatedSnapshotFailure(@Nullable
                                                                                          MetricOptions props)

Deprecated. use opensearchservice module instead

(deprecated) Metric for automated snapshot failures.

Default: maximum over 5 minutes

Parameters:

props -

metricAutomatedSnapshotFailure

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Metric metricAutomatedSnapshotFailure()

Deprecated. use opensearchservice module instead

(deprecated) Metric for automated snapshot failures.

Default: maximum over 5 minutes

metricClusterIndexWritesBlocked

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Metric metricClusterIndexWritesBlocked(@Nullable
                                                                                           MetricOptions props)

Deprecated. use opensearchservice module instead

(deprecated) Metric for the cluster blocking index writes.

Default: maximum over 1 minute

Parameters:

props -

metricClusterIndexWritesBlocked

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Metric metricClusterIndexWritesBlocked()

Deprecated. use opensearchservice module instead

(deprecated) Metric for the cluster blocking index writes.

Default: maximum over 1 minute

metricClusterStatusRed

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Metric metricClusterStatusRed(@Nullable
                                                                                  MetricOptions props)

Deprecated. use opensearchservice module instead

(deprecated) Metric for the time the cluster status is red.

Default: maximum over 5 minutes

Parameters:

props -

metricClusterStatusRed

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Metric metricClusterStatusRed()

Deprecated. use opensearchservice module instead

(deprecated) Metric for the time the cluster status is red.

Default: maximum over 5 minutes

metricClusterStatusYellow

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Metric metricClusterStatusYellow(@Nullable
                                                                                     MetricOptions props)

Deprecated. use opensearchservice module instead

(deprecated) Metric for the time the cluster status is yellow.

Default: maximum over 5 minutes

Parameters:

props -

metricClusterStatusYellow

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Metric metricClusterStatusYellow()

Deprecated. use opensearchservice module instead

(deprecated) Metric for the time the cluster status is yellow.

Default: maximum over 5 minutes

metricCPUUtilization

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Metric metricCPUUtilization(@Nullable
                                                                                MetricOptions props)

Deprecated. use opensearchservice module instead

(deprecated) Metric for CPU utilization.

Default: maximum over 5 minutes

Parameters:

props -

metricCPUUtilization

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Metric metricCPUUtilization()

Deprecated. use opensearchservice module instead

(deprecated) Metric for CPU utilization.

Default: maximum over 5 minutes

metricFreeStorageSpace

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Metric metricFreeStorageSpace(@Nullable
                                                                                  MetricOptions props)

Deprecated. use opensearchservice module instead

(deprecated) Metric for the storage space of nodes in the cluster.

Default: minimum over 5 minutes

Parameters:

props -

metricFreeStorageSpace

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Metric metricFreeStorageSpace()

Deprecated. use opensearchservice module instead

(deprecated) Metric for the storage space of nodes in the cluster.

Default: minimum over 5 minutes

metricIndexingLatency

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Metric metricIndexingLatency(@Nullable
                                                                                 MetricOptions props)

Deprecated. use opensearchservice module instead

(deprecated) Metric for indexing latency.

Default: p99 over 5 minutes

Parameters:

props -

metricIndexingLatency

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Metric metricIndexingLatency()

Deprecated. use opensearchservice module instead

(deprecated) Metric for indexing latency.

Default: p99 over 5 minutes

metricJVMMemoryPressure

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Metric metricJVMMemoryPressure(@Nullable
                                                                                   MetricOptions props)

Deprecated. use opensearchservice module instead

(deprecated) Metric for JVM memory pressure.

Default: maximum over 5 minutes

Parameters:

props -

metricJVMMemoryPressure

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Metric metricJVMMemoryPressure()

Deprecated. use opensearchservice module instead

(deprecated) Metric for JVM memory pressure.

Default: maximum over 5 minutes

metricKMSKeyError

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Metric metricKMSKeyError(@Nullable
                                                                             MetricOptions props)

Deprecated. use opensearchservice module instead

(deprecated) Metric for KMS key errors.

Default: maximum over 5 minutes

Parameters:

props -

metricKMSKeyError

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Metric metricKMSKeyError()

Deprecated. use opensearchservice module instead

(deprecated) Metric for KMS key errors.

Default: maximum over 5 minutes

metricKMSKeyInaccessible

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Metric metricKMSKeyInaccessible(@Nullable
                                                                                    MetricOptions props)

Deprecated. use opensearchservice module instead

(deprecated) Metric for KMS key being inaccessible.

Default: maximum over 5 minutes

Parameters:

props -

metricKMSKeyInaccessible

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Metric metricKMSKeyInaccessible()

Deprecated. use opensearchservice module instead

(deprecated) Metric for KMS key being inaccessible.

Default: maximum over 5 minutes

metricMasterCPUUtilization

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Metric metricMasterCPUUtilization(@Nullable
                                                                                      MetricOptions props)

Deprecated. use opensearchservice module instead

(deprecated) Metric for master CPU utilization.

Default: maximum over 5 minutes

Parameters:

props -

metricMasterCPUUtilization

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Metric metricMasterCPUUtilization()

Deprecated. use opensearchservice module instead

(deprecated) Metric for master CPU utilization.

Default: maximum over 5 minutes

metricMasterJVMMemoryPressure

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Metric metricMasterJVMMemoryPressure(@Nullable
                                                                                         MetricOptions props)

Deprecated. use opensearchservice module instead

(deprecated) Metric for master JVM memory pressure.

Default: maximum over 5 minutes

Parameters:

props -

metricMasterJVMMemoryPressure

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Metric metricMasterJVMMemoryPressure()

Deprecated. use opensearchservice module instead

(deprecated) Metric for master JVM memory pressure.

Default: maximum over 5 minutes

metricNodes

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Metric metricNodes(@Nullable
                                                                       MetricOptions props)

Deprecated. use opensearchservice module instead

(deprecated) Metric for the number of nodes.

Default: minimum over 1 hour

Parameters:

props -

metricNodes

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Metric metricNodes()

Deprecated. use opensearchservice module instead

(deprecated) Metric for the number of nodes.

Default: minimum over 1 hour

metricSearchableDocuments

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Metric metricSearchableDocuments(@Nullable
                                                                                     MetricOptions props)

Deprecated. use opensearchservice module instead

(deprecated) Metric for number of searchable documents.

Default: maximum over 5 minutes

Parameters:

props -

metricSearchableDocuments

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Metric metricSearchableDocuments()

Deprecated. use opensearchservice module instead

(deprecated) Metric for number of searchable documents.

Default: maximum over 5 minutes

metricSearchLatency

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Metric metricSearchLatency(@Nullable
                                                                               MetricOptions props)

Deprecated. use opensearchservice module instead

(deprecated) Metric for search latency.

Default: p99 over 5 minutes

Parameters:

props -

metricSearchLatency

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Metric metricSearchLatency()

Deprecated. use opensearchservice module instead

(deprecated) Metric for search latency.

Default: p99 over 5 minutes