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

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:01:21.053Z")
 @Stability(value=Experimental)
public interface IDomain
extends software.amazon.jsii.JsiiSerializable, IResource

(experimental) 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 Internal default implementation for IDomain.
static class	IDomain.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method and Description
String	getDomainArn() (experimental) Arn of the Elasticsearch domain.
String	getDomainEndpoint() (experimental) Endpoint of the Elasticsearch domain.
String	getDomainName() (experimental) Domain name of the Elasticsearch domain.
Grant	grantIndexRead(String index, IGrantable identity) (experimental) Grant read permissions for an index in this domain to an IAM principal (Role/Group/User).
Grant	grantIndexReadWrite(String index, IGrantable identity) (experimental) Grant read/write permissions for an index in this domain to an IAM principal (Role/Group/User).
Grant	grantIndexWrite(String index, IGrantable identity) (experimental) Grant write permissions for an index in this domain to an IAM principal (Role/Group/User).
Grant	grantPathRead(String path, IGrantable identity) (experimental) Grant read permissions for a specific path in this domain to an IAM principal (Role/Group/User).
Grant	grantPathReadWrite(String path, IGrantable identity) (experimental) Grant read/write permissions for a specific path in this domain to an IAM principal (Role/Group/User).
Grant	grantPathWrite(String path, IGrantable identity) (experimental) Grant write permissions for a specific path in this domain to an IAM principal (Role/Group/User).
Grant	grantRead(IGrantable identity) (experimental) Grant read permissions for this domain and its contents to an IAM principal (Role/Group/User).
Grant	grantReadWrite(IGrantable identity) (experimental) Grant read/write permissions for this domain and its contents to an IAM principal (Role/Group/User).
Grant	grantWrite(IGrantable identity) (experimental) Grant write permissions for this domain and its contents to an IAM principal (Role/Group/User).
Metric	metric(String metricName) (experimental) Return the given named metric for this Domain.
Metric	metric(String metricName, MetricOptions props) (experimental) Return the given named metric for this Domain.
Metric	metricAutomatedSnapshotFailure() (experimental) Metric for automated snapshot failures.
Metric	metricAutomatedSnapshotFailure(MetricOptions props) (experimental) Metric for automated snapshot failures.
Metric	metricClusterIndexWritesBlocked() (experimental) Metric for the cluster blocking index writes.
Metric	metricClusterIndexWritesBlocked(MetricOptions props) (experimental) Metric for the cluster blocking index writes.
Metric	metricClusterStatusRed() (experimental) Metric for the time the cluster status is red.
Metric	metricClusterStatusRed(MetricOptions props) (experimental) Metric for the time the cluster status is red.
Metric	metricClusterStatusYellow() (experimental) Metric for the time the cluster status is yellow.
Metric	metricClusterStatusYellow(MetricOptions props) (experimental) Metric for the time the cluster status is yellow.
Metric	metricCPUUtilization() (experimental) Metric for CPU utilization.
Metric	metricCPUUtilization(MetricOptions props) (experimental) Metric for CPU utilization.
Metric	metricFreeStorageSpace() (experimental) Metric for the storage space of nodes in the cluster.
Metric	metricFreeStorageSpace(MetricOptions props) (experimental) Metric for the storage space of nodes in the cluster.
Metric	metricIndexingLatency() (experimental) Metric for indexing latency.
Metric	metricIndexingLatency(MetricOptions props) (experimental) Metric for indexing latency.
Metric	metricJVMMemoryPressure() (experimental) Metric for JVM memory pressure.
Metric	metricJVMMemoryPressure(MetricOptions props) (experimental) Metric for JVM memory pressure.
Metric	metricKMSKeyError() (experimental) Metric for KMS key errors.
Metric	metricKMSKeyError(MetricOptions props) (experimental) Metric for KMS key errors.
Metric	metricKMSKeyInaccessible() (experimental) Metric for KMS key being inaccessible.
Metric	metricKMSKeyInaccessible(MetricOptions props) (experimental) Metric for KMS key being inaccessible.
Metric	metricMasterCPUUtilization() (experimental) Metric for master CPU utilization.
Metric	metricMasterCPUUtilization(MetricOptions props) (experimental) Metric for master CPU utilization.
Metric	metricMasterJVMMemoryPressure() (experimental) Metric for master JVM memory pressure.
Metric	metricMasterJVMMemoryPressure(MetricOptions props) (experimental) Metric for master JVM memory pressure.
Metric	metricNodes() (experimental) Metric for the number of nodes.
Metric	metricNodes(MetricOptions props) (experimental) Metric for the number of nodes.
Metric	metricSearchableDocuments() (experimental) Metric for number of searchable documents.
Metric	metricSearchableDocuments(MetricOptions props) (experimental) Metric for number of searchable documents.
Metric	metricSearchLatency() (experimental) Metric for search latency.
Metric	metricSearchLatency(MetricOptions props) (experimental) Metric for search latency.

Methods inherited from interface software.amazon.awscdk.IResource

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=Experimental)
 @NotNull
String getDomainArn()

(experimental) Arn of the Elasticsearch domain.

getDomainEndpoint

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

(experimental) Endpoint of the Elasticsearch domain.

getDomainName

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

(experimental) Domain name of the Elasticsearch domain.

grantIndexRead

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

(experimental) 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=Experimental)
 @NotNull
Grant grantIndexReadWrite(@NotNull
                                                                   String index,
                                                                   @NotNull
                                                                   IGrantable identity)

(experimental) 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=Experimental)
 @NotNull
Grant grantIndexWrite(@NotNull
                                                               String index,
                                                               @NotNull
                                                               IGrantable identity)

(experimental) 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=Experimental)
 @NotNull
Grant grantPathRead(@NotNull
                                                             String path,
                                                             @NotNull
                                                             IGrantable identity)

(experimental) 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=Experimental)
 @NotNull
Grant grantPathReadWrite(@NotNull
                                                                  String path,
                                                                  @NotNull
                                                                  IGrantable identity)

(experimental) 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=Experimental)
 @NotNull
Grant grantPathWrite(@NotNull
                                                              String path,
                                                              @NotNull
                                                              IGrantable identity)

(experimental) 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=Experimental)
 @NotNull
Grant grantRead(@NotNull
                                                         IGrantable identity)

(experimental) 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=Experimental)
 @NotNull
Grant grantReadWrite(@NotNull
                                                              IGrantable identity)

(experimental) 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=Experimental)
 @NotNull
Grant grantWrite(@NotNull
                                                          IGrantable identity)

(experimental) 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=Experimental)
 @NotNull
Metric metric(@NotNull
                                                       String metricName,
                                                       @Nullable
                                                       MetricOptions props)

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

Parameters:

metricName - This parameter is required.

props -

metric

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

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

Parameters:

metricName - This parameter is required.

metricAutomatedSnapshotFailure

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

(experimental) Metric for automated snapshot failures.

Default: maximum over 5 minutes

Parameters:

props -

metricAutomatedSnapshotFailure

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

(experimental) Metric for automated snapshot failures.

Default: maximum over 5 minutes

metricClusterIndexWritesBlocked

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

(experimental) Metric for the cluster blocking index writes.

Default: maximum over 1 minute

Parameters:

props -

metricClusterIndexWritesBlocked

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

(experimental) Metric for the cluster blocking index writes.

Default: maximum over 1 minute

metricClusterStatusRed

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

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

Default: maximum over 5 minutes

Parameters:

props -

metricClusterStatusRed

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

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

Default: maximum over 5 minutes

metricClusterStatusYellow

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

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

Default: maximum over 5 minutes

Parameters:

props -

metricClusterStatusYellow

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

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

Default: maximum over 5 minutes

metricCPUUtilization

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

(experimental) Metric for CPU utilization.

Default: maximum over 5 minutes

Parameters:

props -

metricCPUUtilization

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

(experimental) Metric for CPU utilization.

Default: maximum over 5 minutes

metricFreeStorageSpace

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

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

Default: minimum over 5 minutes

Parameters:

props -

metricFreeStorageSpace

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

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

Default: minimum over 5 minutes

metricIndexingLatency

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

(experimental) Metric for indexing latency.

Default: p99 over 5 minutes

Parameters:

props -

metricIndexingLatency

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

(experimental) Metric for indexing latency.

Default: p99 over 5 minutes

metricJVMMemoryPressure

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

(experimental) Metric for JVM memory pressure.

Default: maximum over 5 minutes

Parameters:

props -

metricJVMMemoryPressure

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

(experimental) Metric for JVM memory pressure.

Default: maximum over 5 minutes

metricKMSKeyError

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

(experimental) Metric for KMS key errors.

Default: maximum over 5 minutes

Parameters:

props -

metricKMSKeyError

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

(experimental) Metric for KMS key errors.

Default: maximum over 5 minutes

metricKMSKeyInaccessible

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

(experimental) Metric for KMS key being inaccessible.

Default: maximum over 5 minutes

Parameters:

props -

metricKMSKeyInaccessible

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

(experimental) Metric for KMS key being inaccessible.

Default: maximum over 5 minutes

metricMasterCPUUtilization

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

(experimental) Metric for master CPU utilization.

Default: maximum over 5 minutes

Parameters:

props -

metricMasterCPUUtilization

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

(experimental) Metric for master CPU utilization.

Default: maximum over 5 minutes

metricMasterJVMMemoryPressure

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

(experimental) Metric for master JVM memory pressure.

Default: maximum over 5 minutes

Parameters:

props -

metricMasterJVMMemoryPressure

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

(experimental) Metric for master JVM memory pressure.

Default: maximum over 5 minutes

metricNodes

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

(experimental) Metric for the number of nodes.

Default: minimum over 1 hour

Parameters:

props -

metricNodes

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

(experimental) Metric for the number of nodes.

Default: minimum over 1 hour

metricSearchableDocuments

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

(experimental) Metric for number of searchable documents.

Default: maximum over 5 minutes

Parameters:

props -

metricSearchableDocuments

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

(experimental) Metric for number of searchable documents.

Default: maximum over 5 minutes

metricSearchLatency

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

(experimental) Metric for search latency.

Default: p99 over 5 minutes

Parameters:

props -

metricSearchLatency

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

(experimental) Metric for search latency.

Default: p99 over 5 minutes