software.amazon.awscdk.services.elasticsearch

Interface IDomain

All Superinterfaces:

IConstruct, IDependable, IResource

All Known Subinterfaces:

IDomain.Jsii$Default

All Known Implementing Classes:

Domain, IDomain.Jsii$Proxy

Deprecated.

use opensearchservice module instead

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-17T17:31:18.694Z")
 @Deprecated
public interface IDomain
extends 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
java.lang.String	getDomainArn() Deprecated. use opensearchservice module instead
java.lang.String	getDomainEndpoint() Deprecated. use opensearchservice module instead
java.lang.String	getDomainName() Deprecated. use opensearchservice module instead
Grant	grantIndexRead(java.lang.String index, IGrantable identity) Deprecated. use opensearchservice module instead
Grant	grantIndexReadWrite(java.lang.String index, IGrantable identity) Deprecated. use opensearchservice module instead
Grant	grantIndexWrite(java.lang.String index, IGrantable identity) Deprecated. use opensearchservice module instead
Grant	grantPathRead(java.lang.String path, IGrantable identity) Deprecated. use opensearchservice module instead
Grant	grantPathReadWrite(java.lang.String path, IGrantable identity) Deprecated. use opensearchservice module instead
Grant	grantPathWrite(java.lang.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(java.lang.String metricName) Deprecated. use opensearchservice module instead
Metric	metric(java.lang.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.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Method Detail

getDomainArn

@Deprecated
java.lang.String getDomainArn()

Deprecated. use opensearchservice module instead

(deprecated) Arn of the Elasticsearch domain.

getDomainEndpoint

@Deprecated
java.lang.String getDomainEndpoint()

Deprecated. use opensearchservice module instead

(deprecated) Endpoint of the Elasticsearch domain.

getDomainName

@Deprecated
java.lang.String getDomainName()

Deprecated. use opensearchservice module instead

(deprecated) Domain name of the Elasticsearch domain.

grantIndexRead

@Deprecated
Grant grantIndexRead(java.lang.String index,
                                 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

@Deprecated
Grant grantIndexReadWrite(java.lang.String index,
                                      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

@Deprecated
Grant grantIndexWrite(java.lang.String index,
                                  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

@Deprecated
Grant grantPathRead(java.lang.String path,
                                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

@Deprecated
Grant grantPathReadWrite(java.lang.String path,
                                     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

@Deprecated
Grant grantPathWrite(java.lang.String path,
                                 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

@Deprecated
Grant grantRead(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

@Deprecated
Grant grantReadWrite(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

@Deprecated
Grant grantWrite(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

@Deprecated
Metric metric(java.lang.String metricName,
                          MetricOptions props)

Deprecated. use opensearchservice module instead

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

Parameters:

metricName - This parameter is required.

props -

metric

@Deprecated
Metric metric(java.lang.String metricName)

Deprecated. use opensearchservice module instead

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

Parameters:

metricName - This parameter is required.

metricAutomatedSnapshotFailure

@Deprecated
Metric metricAutomatedSnapshotFailure(MetricOptions props)

Deprecated. use opensearchservice module instead

(deprecated) Metric for automated snapshot failures.

Default: maximum over 5 minutes

Parameters:

props -

metricAutomatedSnapshotFailure

@Deprecated
Metric metricAutomatedSnapshotFailure()

Deprecated. use opensearchservice module instead

(deprecated) Metric for automated snapshot failures.

Default: maximum over 5 minutes

metricClusterIndexWritesBlocked

@Deprecated
Metric metricClusterIndexWritesBlocked(MetricOptions props)

Deprecated. use opensearchservice module instead

(deprecated) Metric for the cluster blocking index writes.

Default: maximum over 1 minute

Parameters:

props -

metricClusterIndexWritesBlocked

@Deprecated
Metric metricClusterIndexWritesBlocked()

Deprecated. use opensearchservice module instead

(deprecated) Metric for the cluster blocking index writes.

Default: maximum over 1 minute

metricClusterStatusRed

@Deprecated
Metric metricClusterStatusRed(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

@Deprecated
Metric metricClusterStatusRed()

Deprecated. use opensearchservice module instead

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

Default: maximum over 5 minutes

metricClusterStatusYellow

@Deprecated
Metric metricClusterStatusYellow(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

@Deprecated
Metric metricClusterStatusYellow()

Deprecated. use opensearchservice module instead

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

Default: maximum over 5 minutes

metricCPUUtilization

@Deprecated
Metric metricCPUUtilization(MetricOptions props)

Deprecated. use opensearchservice module instead

(deprecated) Metric for CPU utilization.

Default: maximum over 5 minutes

Parameters:

props -

metricCPUUtilization

@Deprecated
Metric metricCPUUtilization()

Deprecated. use opensearchservice module instead

(deprecated) Metric for CPU utilization.

Default: maximum over 5 minutes

metricFreeStorageSpace

@Deprecated
Metric metricFreeStorageSpace(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

@Deprecated
Metric metricFreeStorageSpace()

Deprecated. use opensearchservice module instead

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

Default: minimum over 5 minutes

metricIndexingLatency

@Deprecated
Metric metricIndexingLatency(MetricOptions props)

Deprecated. use opensearchservice module instead

(deprecated) Metric for indexing latency.

Default: p99 over 5 minutes

Parameters:

props -

metricIndexingLatency

@Deprecated
Metric metricIndexingLatency()

Deprecated. use opensearchservice module instead

(deprecated) Metric for indexing latency.

Default: p99 over 5 minutes

metricJVMMemoryPressure

@Deprecated
Metric metricJVMMemoryPressure(MetricOptions props)

Deprecated. use opensearchservice module instead

(deprecated) Metric for JVM memory pressure.

Default: maximum over 5 minutes

Parameters:

props -

metricJVMMemoryPressure

@Deprecated
Metric metricJVMMemoryPressure()

Deprecated. use opensearchservice module instead

(deprecated) Metric for JVM memory pressure.

Default: maximum over 5 minutes

metricKMSKeyError

@Deprecated
Metric metricKMSKeyError(MetricOptions props)

Deprecated. use opensearchservice module instead

(deprecated) Metric for KMS key errors.

Default: maximum over 5 minutes

Parameters:

props -

metricKMSKeyError

@Deprecated
Metric metricKMSKeyError()

Deprecated. use opensearchservice module instead

(deprecated) Metric for KMS key errors.

Default: maximum over 5 minutes

metricKMSKeyInaccessible

@Deprecated
Metric metricKMSKeyInaccessible(MetricOptions props)

Deprecated. use opensearchservice module instead

(deprecated) Metric for KMS key being inaccessible.

Default: maximum over 5 minutes

Parameters:

props -

metricKMSKeyInaccessible

@Deprecated
Metric metricKMSKeyInaccessible()

Deprecated. use opensearchservice module instead

(deprecated) Metric for KMS key being inaccessible.

Default: maximum over 5 minutes

metricMasterCPUUtilization

@Deprecated
Metric metricMasterCPUUtilization(MetricOptions props)

Deprecated. use opensearchservice module instead

(deprecated) Metric for master CPU utilization.

Default: maximum over 5 minutes

Parameters:

props -

metricMasterCPUUtilization

@Deprecated
Metric metricMasterCPUUtilization()

Deprecated. use opensearchservice module instead

(deprecated) Metric for master CPU utilization.

Default: maximum over 5 minutes

metricMasterJVMMemoryPressure

@Deprecated
Metric metricMasterJVMMemoryPressure(MetricOptions props)

Deprecated. use opensearchservice module instead

(deprecated) Metric for master JVM memory pressure.

Default: maximum over 5 minutes

Parameters:

props -

metricMasterJVMMemoryPressure

@Deprecated
Metric metricMasterJVMMemoryPressure()

Deprecated. use opensearchservice module instead

(deprecated) Metric for master JVM memory pressure.

Default: maximum over 5 minutes

metricNodes

@Deprecated
Metric metricNodes(MetricOptions props)

Deprecated. use opensearchservice module instead

(deprecated) Metric for the number of nodes.

Default: minimum over 1 hour

Parameters:

props -

metricNodes

@Deprecated
Metric metricNodes()

Deprecated. use opensearchservice module instead

(deprecated) Metric for the number of nodes.

Default: minimum over 1 hour

metricSearchableDocuments

@Deprecated
Metric metricSearchableDocuments(MetricOptions props)

Deprecated. use opensearchservice module instead

(deprecated) Metric for number of searchable documents.

Default: maximum over 5 minutes

Parameters:

props -

metricSearchableDocuments

@Deprecated
Metric metricSearchableDocuments()

Deprecated. use opensearchservice module instead

(deprecated) Metric for number of searchable documents.

Default: maximum over 5 minutes

metricSearchLatency

@Deprecated
Metric metricSearchLatency(MetricOptions props)

Deprecated. use opensearchservice module instead

(deprecated) Metric for search latency.

Default: p99 over 5 minutes

Parameters:

props -

metricSearchLatency

@Deprecated
Metric metricSearchLatency()

Deprecated. use opensearchservice module instead

(deprecated) Metric for search latency.

Default: p99 over 5 minutes