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
IDomain
.-
Nested Class Summary
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy
Nested classes/interfaces inherited from interface software.constructs.IDependable
software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.opensearchservice.IDomain
IDomain.Jsii$Default, IDomain.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default, IResource.Jsii$Proxy
-
Method Summary
Modifier and TypeMethodDescriptiondefault void
applyRemovalPolicy
(RemovalPolicy policy) Apply the given removal policy to this resource.default String
Arn of the Amazon OpenSearch Service domain.default String
Endpoint of the Amazon OpenSearch Service domain.default String
Identifier of the Amazon OpenSearch Service domain.default String
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
Metric for automated snapshot failures.default Metric
Metric for the cluster blocking index writes.default Metric
Metric for the time the cluster status is red.default Metric
Metric for the time the cluster status is yellow.default Metric
Metric for CPU utilization.default Metric
Metric for the storage space of nodes in the cluster.default Metric
Metric for indexing latency.default Metric
Metric for JVM memory pressure.default Metric
metricKMSKeyError
(MetricOptions props) Metric for KMS key errors.default Metric
Metric for KMS key being inaccessible.default Metric
Metric for master CPU utilization.default Metric
Metric for master JVM memory pressure.default Metric
metricNodes
(MetricOptions props) Metric for the number of nodes.default Metric
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 Details
-
getNode
@Stability(Stable) @NotNull default software.constructs.Node getNode()The tree node.- Specified by:
getNode
in interfacesoftware.constructs.IConstruct
- Specified by:
getNode
in interfacesoftware.constructs.IConstruct.Jsii$Default
- Specified by:
getNode
in interfaceIResource.Jsii$Default
-
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 interfaceIResource
- Specified by:
getEnv
in interfaceIResource.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStack
in interfaceIResource
- Specified by:
getStack
in interfaceIResource.Jsii$Default
-
getDomainArn
Arn of the Amazon OpenSearch Service domain.- Specified by:
getDomainArn
in interfaceIDomain
-
getDomainEndpoint
Endpoint of the Amazon OpenSearch Service domain.- Specified by:
getDomainEndpoint
in interfaceIDomain
-
getDomainId
Identifier of the Amazon OpenSearch Service domain.- Specified by:
getDomainId
in interfaceIDomain
-
getDomainName
Domain name of the Amazon OpenSearch Service domain.- Specified by:
getDomainName
in interfaceIDomain
-
applyRemovalPolicy
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 interfaceIResource
- Specified by:
applyRemovalPolicy
in interfaceIResource.Jsii$Default
- Parameters:
policy
- This parameter is required.
-
grantIndexRead
@Stability(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 interfaceIDomain
- Parameters:
index
- The index to grant permissions for. This parameter is required.identity
- The principal. This parameter is required.
-
grantIndexReadWrite
@Stability(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 interfaceIDomain
- Parameters:
index
- The index to grant permissions for. This parameter is required.identity
- The principal. This parameter is required.
-
grantIndexWrite
@Stability(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 interfaceIDomain
- Parameters:
index
- The index to grant permissions for. This parameter is required.identity
- The principal. This parameter is required.
-
grantPathRead
@Stability(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 interfaceIDomain
- Parameters:
path
- The path to grant permissions for. This parameter is required.identity
- The principal. This parameter is required.
-
grantPathReadWrite
@Stability(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 interfaceIDomain
- Parameters:
path
- The path to grant permissions for. This parameter is required.identity
- The principal. This parameter is required.
-
grantPathWrite
@Stability(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 interfaceIDomain
- Parameters:
path
- The path to grant permissions for. This parameter is required.identity
- The principal. This parameter is required.
-
grantRead
Grant read permissions for this domain and its contents to an IAM principal (Role/Group/User). -
grantReadWrite
Grant read/write permissions for this domain and its contents to an IAM principal (Role/Group/User).- Specified by:
grantReadWrite
in interfaceIDomain
- Parameters:
identity
- The principal. This parameter is required.
-
grantWrite
Grant write permissions for this domain and its contents to an IAM principal (Role/Group/User).- Specified by:
grantWrite
in interfaceIDomain
- Parameters:
identity
- The principal. This parameter is required.
-
metric
@Stability(Stable) @NotNull default Metric metric(@NotNull String metricName, @Nullable MetricOptions props) Return the given named metric for this domain. -
metricAutomatedSnapshotFailure
@Stability(Stable) @NotNull default Metric metricAutomatedSnapshotFailure(@Nullable MetricOptions props) Metric for automated snapshot failures.Default: maximum over 5 minutes
- Specified by:
metricAutomatedSnapshotFailure
in interfaceIDomain
- Parameters:
props
-
-
metricClusterIndexWritesBlocked
@Stability(Stable) @NotNull default Metric metricClusterIndexWritesBlocked(@Nullable MetricOptions props) Metric for the cluster blocking index writes.Default: maximum over 1 minute
- Specified by:
metricClusterIndexWritesBlocked
in interfaceIDomain
- Parameters:
props
-
-
metricClusterStatusRed
Metric for the time the cluster status is red.Default: maximum over 5 minutes
- Specified by:
metricClusterStatusRed
in interfaceIDomain
- Parameters:
props
-
-
metricClusterStatusYellow
Metric for the time the cluster status is yellow.Default: maximum over 5 minutes
- Specified by:
metricClusterStatusYellow
in interfaceIDomain
- Parameters:
props
-
-
metricCPUUtilization
Metric for CPU utilization.Default: maximum over 5 minutes
- Specified by:
metricCPUUtilization
in interfaceIDomain
- Parameters:
props
-
-
metricFreeStorageSpace
Metric for the storage space of nodes in the cluster.Default: minimum over 5 minutes
- Specified by:
metricFreeStorageSpace
in interfaceIDomain
- Parameters:
props
-
-
metricIndexingLatency
Metric for indexing latency.Default: p99 over 5 minutes
- Specified by:
metricIndexingLatency
in interfaceIDomain
- Parameters:
props
-
-
metricJVMMemoryPressure
Metric for JVM memory pressure.Default: maximum over 5 minutes
- Specified by:
metricJVMMemoryPressure
in interfaceIDomain
- Parameters:
props
-
-
metricKMSKeyError
Metric for KMS key errors.Default: maximum over 5 minutes
- Specified by:
metricKMSKeyError
in interfaceIDomain
- Parameters:
props
-
-
metricKMSKeyInaccessible
Metric for KMS key being inaccessible.Default: maximum over 5 minutes
- Specified by:
metricKMSKeyInaccessible
in interfaceIDomain
- Parameters:
props
-
-
metricMasterCPUUtilization
@Stability(Stable) @NotNull default Metric metricMasterCPUUtilization(@Nullable MetricOptions props) Metric for master CPU utilization.Default: maximum over 5 minutes
- Specified by:
metricMasterCPUUtilization
in interfaceIDomain
- Parameters:
props
-
-
metricMasterJVMMemoryPressure
@Stability(Stable) @NotNull default Metric metricMasterJVMMemoryPressure(@Nullable MetricOptions props) Metric for master JVM memory pressure.Default: maximum over 5 minutes
- Specified by:
metricMasterJVMMemoryPressure
in interfaceIDomain
- Parameters:
props
-
-
metricNodes
Metric for the number of nodes.Default: minimum over 1 hour
- Specified by:
metricNodes
in interfaceIDomain
- Parameters:
props
-
-
metricSearchableDocuments
Metric for number of searchable documents.Default: maximum over 5 minutes
- Specified by:
metricSearchableDocuments
in interfaceIDomain
- Parameters:
props
-
-
metricSearchLatency
Metric for search latency.Default: p99 over 5 minutes
- Specified by:
metricSearchLatency
in interfaceIDomain
- Parameters:
props
-
-