software.amazon.awscdk.services.opensearchservice

Interface IDomain.Jsii$Default

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IDomain, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IDomain.Jsii$Proxy

Enclosing interface:

IDomain

@Internal
public static interface IDomain.Jsii$Default
extends IDomain, IResource.Jsii$Default

Internal default implementation for IDomain.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.opensearchservice.IDomain

IDomain.Jsii$Default, IDomain.Jsii$Proxy

Method Summary

Modifier and Type	Method and Description
default void	applyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.
default String	getDomainArn() Arn of the Amazon OpenSearch Service domain.
default String	getDomainEndpoint() Endpoint of the Amazon OpenSearch Service domain.
default String	getDomainId() Identifier of the Amazon OpenSearch Service domain.
default String	getDomainName() Domain name of the Amazon OpenSearch Service domain.
default ResourceEnvironment	getEnv() The environment this resource belongs to.
default software.constructs.Node	getNode() The tree node.
default Stack	getStack() The stack in which this resource is defined.
default Grant	grantIndexRead(String index, IGrantable identity) Grant read permissions for an index in this domain to an IAM principal (Role/Group/User).
default Grant	grantIndexReadWrite(String index, IGrantable identity) Grant read/write permissions for an index in this domain to an IAM principal (Role/Group/User).
default Grant	grantIndexWrite(String index, IGrantable identity) Grant write permissions for an index in this domain to an IAM principal (Role/Group/User).
default Grant	grantPathRead(String path, IGrantable identity) Grant read permissions for a specific path in this domain to an IAM principal (Role/Group/User).
default Grant	grantPathReadWrite(String path, IGrantable identity) Grant read/write permissions for a specific path in this domain to an IAM principal (Role/Group/User).
default Grant	grantPathWrite(String path, IGrantable identity) Grant write permissions for a specific path in this domain to an IAM principal (Role/Group/User).
default Grant	grantRead(IGrantable identity) Grant read permissions for this domain and its contents to an IAM principal (Role/Group/User).
default Grant	grantReadWrite(IGrantable identity) Grant read/write permissions for this domain and its contents to an IAM principal (Role/Group/User).
default Grant	grantWrite(IGrantable identity) Grant write permissions for this domain and its contents to an IAM principal (Role/Group/User).
default Metric	metric(String metricName, MetricOptions props) Return the given named metric for this domain.
default Metric	metricAutomatedSnapshotFailure(MetricOptions props) Metric for automated snapshot failures.
default Metric	metricClusterIndexWritesBlocked(MetricOptions props) Metric for the cluster blocking index writes.
default Metric	metricClusterStatusRed(MetricOptions props) Metric for the time the cluster status is red.
default Metric	metricClusterStatusYellow(MetricOptions props) Metric for the time the cluster status is yellow.
default Metric	metricCPUUtilization(MetricOptions props) Metric for CPU utilization.
default Metric	metricFreeStorageSpace(MetricOptions props) Metric for the storage space of nodes in the cluster.
default Metric	metricIndexingLatency(MetricOptions props) Metric for indexing latency.
default Metric	metricJVMMemoryPressure(MetricOptions props) Metric for JVM memory pressure.
default Metric	metricKMSKeyError(MetricOptions props) Metric for KMS key errors.
default Metric	metricKMSKeyInaccessible(MetricOptions props) Metric for KMS key being inaccessible.
default Metric	metricMasterCPUUtilization(MetricOptions props) Metric for master CPU utilization.
default Metric	metricMasterJVMMemoryPressure(MetricOptions props) Metric for master JVM memory pressure.
default Metric	metricNodes(MetricOptions props) Metric for the number of nodes.
default Metric	metricSearchableDocuments(MetricOptions props) Metric for number of searchable documents.
default Metric	metricSearchLatency(MetricOptions props) Metric for search latency.

Methods inherited from interface software.amazon.awscdk.services.opensearchservice.IDomain

metric, metricAutomatedSnapshotFailure, metricClusterIndexWritesBlocked, metricClusterStatusRed, metricClusterStatusYellow, metricCPUUtilization, metricFreeStorageSpace, metricIndexingLatency, metricJVMMemoryPressure, metricKMSKeyError, metricKMSKeyInaccessible, metricMasterCPUUtilization, metricMasterJVMMemoryPressure, metricNodes, metricSearchableDocuments, metricSearchLatency

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNode

@Stability(value=Stable)
 @NotNull
default software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(value=Stable)
 @NotNull
default ResourceEnvironment getEnv()

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(value=Stable)
 @NotNull
default Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getDomainArn

@Stability(value=Stable)
 @NotNull
default String getDomainArn()

Arn of the Amazon OpenSearch Service domain.

Specified by:

getDomainArn in interface IDomain

getDomainEndpoint

@Stability(value=Stable)
 @NotNull
default String getDomainEndpoint()

Endpoint of the Amazon OpenSearch Service domain.

Specified by:

getDomainEndpoint in interface IDomain

getDomainId

@Stability(value=Stable)
 @NotNull
default String getDomainId()

Identifier of the Amazon OpenSearch Service domain.

Specified by:

getDomainId in interface IDomain

getDomainName

@Stability(value=Stable)
 @NotNull
default String getDomainName()

Domain name of the Amazon OpenSearch Service domain.

Specified by:

getDomainName in interface IDomain

applyRemovalPolicy

@Stability(value=Stable)
default void applyRemovalPolicy(@NotNull
                                                         RemovalPolicy policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.

grantIndexRead

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

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

Specified by:

grantIndexRead in interface IDomain

Parameters:

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

identity - The principal. This parameter is required.

grantIndexReadWrite

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

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

Specified by:

grantIndexReadWrite in interface IDomain

Parameters:

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

identity - The principal. This parameter is required.

grantIndexWrite

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

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

Specified by:

grantIndexWrite in interface IDomain

Parameters:

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

identity - The principal. This parameter is required.

grantPathRead

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

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

Specified by:

grantPathRead in interface IDomain

Parameters:

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

identity - The principal. This parameter is required.

grantPathReadWrite

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

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

Specified by:

grantPathReadWrite in interface IDomain

Parameters:

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

identity - The principal. This parameter is required.

grantPathWrite

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

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

Specified by:

grantPathWrite in interface IDomain

Parameters:

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

identity - The principal. This parameter is required.

grantRead

@Stability(value=Stable)
 @NotNull
default Grant grantRead(@NotNull
                                                           IGrantable identity)

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

Specified by:

grantRead in interface IDomain

Parameters:

identity - The principal. This parameter is required.

grantReadWrite

@Stability(value=Stable)
 @NotNull
default Grant grantReadWrite(@NotNull
                                                                IGrantable identity)

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

Specified by:

grantReadWrite in interface IDomain

Parameters:

identity - The principal. This parameter is required.

grantWrite

@Stability(value=Stable)
 @NotNull
default Grant grantWrite(@NotNull
                                                            IGrantable identity)

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

Specified by:

grantWrite in interface IDomain

Parameters:

identity - The principal. This parameter is required.

metric

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

Return the given named metric for this domain.

Specified by:

metric in interface IDomain

Parameters:

metricName - This parameter is required.

props -

metricAutomatedSnapshotFailure

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

Metric for automated snapshot failures.

Default: maximum over 5 minutes

Specified by:

metricAutomatedSnapshotFailure in interface IDomain

Parameters:

props -

metricClusterIndexWritesBlocked

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

Metric for the cluster blocking index writes.

Default: maximum over 1 minute

Specified by:

metricClusterIndexWritesBlocked in interface IDomain

Parameters:

props -

metricClusterStatusRed

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

Metric for the time the cluster status is red.

Default: maximum over 5 minutes

Specified by:

metricClusterStatusRed in interface IDomain

Parameters:

props -

metricClusterStatusYellow

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

Metric for the time the cluster status is yellow.

Default: maximum over 5 minutes

Specified by:

metricClusterStatusYellow in interface IDomain

Parameters:

props -

metricCPUUtilization

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

Metric for CPU utilization.

Default: maximum over 5 minutes

Specified by:

metricCPUUtilization in interface IDomain

Parameters:

props -

metricFreeStorageSpace

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

Metric for the storage space of nodes in the cluster.

Default: minimum over 5 minutes

Specified by:

metricFreeStorageSpace in interface IDomain

Parameters:

props -

metricIndexingLatency

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

Metric for indexing latency.

Default: p99 over 5 minutes

Specified by:

metricIndexingLatency in interface IDomain

Parameters:

props -

metricJVMMemoryPressure

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

Metric for JVM memory pressure.

Default: maximum over 5 minutes

Specified by:

metricJVMMemoryPressure in interface IDomain

Parameters:

props -

metricKMSKeyError

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

Metric for KMS key errors.

Default: maximum over 5 minutes

Specified by:

metricKMSKeyError in interface IDomain

Parameters:

props -

metricKMSKeyInaccessible

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

Metric for KMS key being inaccessible.

Default: maximum over 5 minutes

Specified by:

metricKMSKeyInaccessible in interface IDomain

Parameters:

props -

metricMasterCPUUtilization

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

Metric for master CPU utilization.

Default: maximum over 5 minutes

Specified by:

metricMasterCPUUtilization in interface IDomain

Parameters:

props -

metricMasterJVMMemoryPressure

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

Metric for master JVM memory pressure.

Default: maximum over 5 minutes

Specified by:

metricMasterJVMMemoryPressure in interface IDomain

Parameters:

props -

metricNodes

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

Metric for the number of nodes.

Default: minimum over 1 hour

Specified by:

metricNodes in interface IDomain

Parameters:

props -

metricSearchableDocuments

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

Metric for number of searchable documents.

Default: maximum over 5 minutes

Specified by:

metricSearchableDocuments in interface IDomain

Parameters:

props -

metricSearchLatency

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

Metric for search latency.

Default: p99 over 5 minutes

Specified by:

metricSearchLatency in interface IDomain

Parameters:

props -