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
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
Deprecated.Internal default implementation forIDomain
.static final class
Deprecated.A proxy class which represents a concrete javascript instance of this type. -
Method Summary
Modifier and TypeMethodDescriptionDeprecated.use opensearchservice module insteadDeprecated.use opensearchservice module insteadDeprecated.use opensearchservice module insteadgrantIndexRead
(String index, IGrantable identity) Deprecated.use opensearchservice module insteadgrantIndexReadWrite
(String index, IGrantable identity) Deprecated.use opensearchservice module insteadgrantIndexWrite
(String index, IGrantable identity) Deprecated.use opensearchservice module insteadgrantPathRead
(String path, IGrantable identity) Deprecated.use opensearchservice module insteadgrantPathReadWrite
(String path, IGrantable identity) Deprecated.use opensearchservice module insteadgrantPathWrite
(String path, IGrantable identity) Deprecated.use opensearchservice module insteadgrantRead
(IGrantable identity) Deprecated.use opensearchservice module insteadgrantReadWrite
(IGrantable identity) Deprecated.use opensearchservice module insteadgrantWrite
(IGrantable identity) Deprecated.use opensearchservice module insteadDeprecated.use opensearchservice module insteadmetric
(String metricName, MetricOptions props) Deprecated.use opensearchservice module insteadDeprecated.use opensearchservice module insteadDeprecated.use opensearchservice module insteadDeprecated.use opensearchservice module insteadDeprecated.use opensearchservice module insteadDeprecated.use opensearchservice module insteadDeprecated.use opensearchservice module insteadDeprecated.use opensearchservice module insteadDeprecated.use opensearchservice module insteadDeprecated.use opensearchservice module insteadDeprecated.use opensearchservice module insteadDeprecated.use opensearchservice module insteadDeprecated.use opensearchservice module insteadDeprecated.use opensearchservice module insteadDeprecated.use opensearchservice module insteadDeprecated.use opensearchservice module insteadDeprecated.use opensearchservice module insteadDeprecated.use opensearchservice module insteadmetricKMSKeyError
(MetricOptions props) Deprecated.use opensearchservice module insteadDeprecated.use opensearchservice module insteadDeprecated.use opensearchservice module insteadDeprecated.use opensearchservice module insteadDeprecated.use opensearchservice module insteadDeprecated.use opensearchservice module insteadDeprecated.use opensearchservice module insteadDeprecated.use opensearchservice module insteadmetricNodes
(MetricOptions props) Deprecated.use opensearchservice module insteadDeprecated.use opensearchservice module insteadDeprecated.use opensearchservice module insteadDeprecated.use opensearchservice module insteadmetricSearchLatency
(MetricOptions props) Deprecated.use opensearchservice module insteadMethods inherited from interface software.constructs.IConstruct
getNode
Methods inherited from interface software.amazon.awscdk.IResource
applyRemovalPolicy, getEnv, getStack
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getDomainArn
Deprecated.use opensearchservice module instead(deprecated) Arn of the Elasticsearch domain. -
getDomainEndpoint
Deprecated.use opensearchservice module instead(deprecated) Endpoint of the Elasticsearch domain. -
getDomainName
Deprecated.use opensearchservice module instead(deprecated) Domain name of the Elasticsearch domain. -
grantIndexRead
@Stability(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(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(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(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(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(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
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.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.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(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
Deprecated.use opensearchservice module instead(deprecated) Return the given named metric for this Domain.- Parameters:
metricName
- This parameter is required.
-
metricAutomatedSnapshotFailure
@Stability(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
Deprecated.use opensearchservice module instead(deprecated) Metric for automated snapshot failures.Default: maximum over 5 minutes
-
metricClusterIndexWritesBlocked
@Stability(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
Deprecated.use opensearchservice module instead(deprecated) Metric for the cluster blocking index writes.Default: maximum over 1 minute
-
metricClusterStatusRed
@Stability(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
Deprecated.use opensearchservice module instead(deprecated) Metric for the time the cluster status is red.Default: maximum over 5 minutes
-
metricClusterStatusYellow
@Stability(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
Deprecated.use opensearchservice module instead(deprecated) Metric for the time the cluster status is yellow.Default: maximum over 5 minutes
-
metricCPUUtilization
@Stability(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
Deprecated.use opensearchservice module instead(deprecated) Metric for CPU utilization.Default: maximum over 5 minutes
-
metricFreeStorageSpace
@Stability(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
Deprecated.use opensearchservice module instead(deprecated) Metric for the storage space of nodes in the cluster.Default: minimum over 5 minutes
-
metricIndexingLatency
@Stability(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
Deprecated.use opensearchservice module instead(deprecated) Metric for indexing latency.Default: p99 over 5 minutes
-
metricJVMMemoryPressure
@Stability(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
Deprecated.use opensearchservice module instead(deprecated) Metric for JVM memory pressure.Default: maximum over 5 minutes
-
metricKMSKeyError
Deprecated.use opensearchservice module instead(deprecated) Metric for KMS key errors.Default: maximum over 5 minutes
- Parameters:
props
-
-
metricKMSKeyError
Deprecated.use opensearchservice module instead(deprecated) Metric for KMS key errors.Default: maximum over 5 minutes
-
metricKMSKeyInaccessible
@Stability(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
Deprecated.use opensearchservice module instead(deprecated) Metric for KMS key being inaccessible.Default: maximum over 5 minutes
-
metricMasterCPUUtilization
@Stability(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
Deprecated.use opensearchservice module instead(deprecated) Metric for master CPU utilization.Default: maximum over 5 minutes
-
metricMasterJVMMemoryPressure
@Stability(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
Deprecated.use opensearchservice module instead(deprecated) Metric for master JVM memory pressure.Default: maximum over 5 minutes
-
metricNodes
Deprecated.use opensearchservice module instead(deprecated) Metric for the number of nodes.Default: minimum over 1 hour
- Parameters:
props
-
-
metricNodes
Deprecated.use opensearchservice module instead(deprecated) Metric for the number of nodes.Default: minimum over 1 hour
-
metricSearchableDocuments
@Stability(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
Deprecated.use opensearchservice module instead(deprecated) Metric for number of searchable documents.Default: maximum over 5 minutes
-
metricSearchLatency
@Stability(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
Deprecated.use opensearchservice module instead(deprecated) Metric for search latency.Default: p99 over 5 minutes
-