interface IDomain
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.OpenSearchService.IDomain |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsopensearchservice#IDomain |
Java | software.amazon.awscdk.services.opensearchservice.IDomain |
Python | aws_cdk.aws_opensearchservice.IDomain |
TypeScript (source) | aws-cdk-lib » aws_opensearchservice » IDomain |
Implemented by
Domain
Obtainable from
Domain
.fromDomainAttributes()
, Domain
.fromDomainEndpoint()
An interface that represents an Amazon OpenSearch Service domain - either created with the CDK, or an existing one.
Properties
Name | Type | Description |
---|---|---|
domain | string | Arn of the Amazon OpenSearch Service domain. |
domain | string | Endpoint of the Amazon OpenSearch Service domain. |
domain | string | Identifier of the Amazon OpenSearch Service domain. |
domain | string | Domain name of the Amazon OpenSearch Service domain. |
env | Resource | The environment this resource belongs to. |
node | Node | The tree node. |
stack | Stack | The stack in which this resource is defined. |
domainArn
Type:
string
Arn of the Amazon OpenSearch Service domain.
domainEndpoint
Type:
string
Endpoint of the Amazon OpenSearch Service domain.
domainId
Type:
string
Identifier of the Amazon OpenSearch Service domain.
domainName
Type:
string
Domain name of the Amazon OpenSearch Service domain.
env
Type:
Resource
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.
node
Type:
Node
The tree node.
stack
Type:
Stack
The stack in which this resource is defined.
Methods
Name | Description |
---|---|
apply | Apply the given removal policy to this resource. |
grant | Grant read permissions for an index in this domain to an IAM principal (Role/Group/User). |
grant | Grant read/write permissions for an index in this domain to an IAM principal (Role/Group/User). |
grant | Grant write permissions for an index in this domain to an IAM principal (Role/Group/User). |
grant | Grant read permissions for a specific path in this domain to an IAM principal (Role/Group/User). |
grant | Grant read/write permissions for a specific path in this domain to an IAM principal (Role/Group/User). |
grant | Grant write permissions for a specific path in this domain to an IAM principal (Role/Group/User). |
grant | Grant read permissions for this domain and its contents to an IAM principal (Role/Group/User). |
grant | Grant read/write permissions for this domain and its contents to an IAM principal (Role/Group/User). |
grant | Grant write permissions for this domain and its contents to an IAM principal (Role/Group/User). |
metric(metricName, props?) | Return the given named metric for this domain. |
metric | Metric for automated snapshot failures. |
metric | Metric for CPU utilization. |
metric | Metric for the cluster blocking index writes. |
metric | Metric for the time the cluster status is red. |
metric | Metric for the time the cluster status is yellow. |
metric | Metric for the storage space of nodes in the cluster. |
metric | Metric for indexing latency. |
metric | Metric for JVM memory pressure. |
metric | Metric for KMS key errors. |
metric | Metric for KMS key being inaccessible. |
metric | Metric for master CPU utilization. |
metric | Metric for master JVM memory pressure. |
metric | Metric for the number of nodes. |
metric | Metric for search latency. |
metric | Metric for number of searchable documents. |
RemovalPolicy(policy)
applypublic applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
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
).
IndexRead(index, identity)
grantpublic grantIndexRead(index: string, identity: IGrantable): Grant
Parameters
- index
string
— The index to grant permissions for. - identity
IGrantable
— The principal.
Returns
Grant read permissions for an index in this domain to an IAM principal (Role/Group/User).
IndexReadWrite(index, identity)
grantpublic grantIndexReadWrite(index: string, identity: IGrantable): Grant
Parameters
- index
string
— The index to grant permissions for. - identity
IGrantable
— The principal.
Returns
Grant read/write permissions for an index in this domain to an IAM principal (Role/Group/User).
IndexWrite(index, identity)
grantpublic grantIndexWrite(index: string, identity: IGrantable): Grant
Parameters
- index
string
— The index to grant permissions for. - identity
IGrantable
— The principal.
Returns
Grant write permissions for an index in this domain to an IAM principal (Role/Group/User).
PathRead(path, identity)
grantpublic grantPathRead(path: string, identity: IGrantable): Grant
Parameters
- path
string
— The path to grant permissions for. - identity
IGrantable
— The principal.
Returns
Grant read permissions for a specific path in this domain to an IAM principal (Role/Group/User).
PathReadWrite(path, identity)
grantpublic grantPathReadWrite(path: string, identity: IGrantable): Grant
Parameters
- path
string
— The path to grant permissions for. - identity
IGrantable
— The principal.
Returns
Grant read/write permissions for a specific path in this domain to an IAM principal (Role/Group/User).
PathWrite(path, identity)
grantpublic grantPathWrite(path: string, identity: IGrantable): Grant
Parameters
- path
string
— The path to grant permissions for. - identity
IGrantable
— The principal.
Returns
Grant write permissions for a specific path in this domain to an IAM principal (Role/Group/User).
Read(identity)
grantpublic grantRead(identity: IGrantable): Grant
Parameters
- identity
IGrantable
— The principal.
Returns
Grant read permissions for this domain and its contents to an IAM principal (Role/Group/User).
ReadWrite(identity)
grantpublic grantReadWrite(identity: IGrantable): Grant
Parameters
- identity
IGrantable
— The principal.
Returns
Grant read/write permissions for this domain and its contents to an IAM principal (Role/Group/User).
Write(identity)
grantpublic grantWrite(identity: IGrantable): Grant
Parameters
- identity
IGrantable
— The principal.
Returns
Grant write permissions for this domain and its contents to an IAM principal (Role/Group/User).
metric(metricName, props?)
public metric(metricName: string, props?: MetricOptions): Metric
Parameters
- metricName
string
- props
Metric
Options
Returns
Return the given named metric for this domain.
AutomatedSnapshotFailure(props?)
metricpublic metricAutomatedSnapshotFailure(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for automated snapshot failures.
CPUUtilization(props?)
metricpublic metricCPUUtilization(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for CPU utilization.
ClusterIndexWritesBlocked(props?)
metricpublic metricClusterIndexWritesBlocked(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the cluster blocking index writes.
ClusterStatusRed(props?)
metricpublic metricClusterStatusRed(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the time the cluster status is red.
ClusterStatusYellow(props?)
metricpublic metricClusterStatusYellow(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the time the cluster status is yellow.
FreeStorageSpace(props?)
metricpublic metricFreeStorageSpace(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the storage space of nodes in the cluster.
IndexingLatency(props?)
metricpublic metricIndexingLatency(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for indexing latency.
JVMMemoryPressure(props?)
metricpublic metricJVMMemoryPressure(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for JVM memory pressure.
KMSKeyError(props?)
metricpublic metricKMSKeyError(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for KMS key errors.
KMSKeyInaccessible(props?)
metricpublic metricKMSKeyInaccessible(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for KMS key being inaccessible.
MasterCPUUtilization(props?)
metricpublic metricMasterCPUUtilization(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for master CPU utilization.
MasterJVMMemoryPressure(props?)
metricpublic metricMasterJVMMemoryPressure(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for master JVM memory pressure.
Nodes(props?)
metricpublic metricNodes(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for the number of nodes.
SearchLatency(props?)
metricpublic metricSearchLatency(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for search latency.
SearchableDocuments(props?)
metricpublic metricSearchableDocuments(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
Metric for number of searchable documents.