Module: AWSCDK::OpenSearchService::IDomain

Includes:
IResource, Interfaces::AWSOpensearchservice::IDomainRef
Included in:
Domain
Defined in:
open_search_service/i_domain.rb

Overview

An interface that represents an Amazon OpenSearch Service domain - either created with the CDK, or an existing one.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'open_search_service/i_domain.rb', line 374

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :domain_ref => { kind: :property, name: "domainRef", is_optional: false },
    :domain_arn => { kind: :property, name: "domainArn", is_optional: false },
    :domain_endpoint => { kind: :property, name: "domainEndpoint", is_optional: false },
    :domain_id => { kind: :property, name: "domainId", is_optional: false },
    :domain_name => { kind: :property, name: "domainName", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :grant_index_read => { kind: :method, name: "grantIndexRead", is_optional: false },
    :grant_index_read_write => { kind: :method, name: "grantIndexReadWrite", is_optional: false },
    :grant_index_write => { kind: :method, name: "grantIndexWrite", is_optional: false },
    :grant_path_read => { kind: :method, name: "grantPathRead", is_optional: false },
    :grant_path_read_write => { kind: :method, name: "grantPathReadWrite", is_optional: false },
    :grant_path_write => { kind: :method, name: "grantPathWrite", is_optional: false },
    :grant_read => { kind: :method, name: "grantRead", is_optional: false },
    :grant_read_write => { kind: :method, name: "grantReadWrite", is_optional: false },
    :grant_write => { kind: :method, name: "grantWrite", is_optional: false },
    :metric => { kind: :method, name: "metric", is_optional: false },
    :metric_automated_snapshot_failure => { kind: :method, name: "metricAutomatedSnapshotFailure", is_optional: false },
    :metric_cluster_index_writes_blocked => { kind: :method, name: "metricClusterIndexWritesBlocked", is_optional: false },
    :metric_cluster_status_red => { kind: :method, name: "metricClusterStatusRed", is_optional: false },
    :metric_cluster_status_yellow => { kind: :method, name: "metricClusterStatusYellow", is_optional: false },
    :metric_cpu_utilization => { kind: :method, name: "metricCPUUtilization", is_optional: false },
    :metric_free_storage_space => { kind: :method, name: "metricFreeStorageSpace", is_optional: false },
    :metric_indexing_latency => { kind: :method, name: "metricIndexingLatency", is_optional: false },
    :metric_jvm_memory_pressure => { kind: :method, name: "metricJVMMemoryPressure", is_optional: false },
    :metric_kms_key_error => { kind: :method, name: "metricKMSKeyError", is_optional: false },
    :metric_kms_key_inaccessible => { kind: :method, name: "metricKMSKeyInaccessible", is_optional: false },
    :metric_master_cpu_utilization => { kind: :method, name: "metricMasterCPUUtilization", is_optional: false },
    :metric_master_jvm_memory_pressure => { kind: :method, name: "metricMasterJVMMemoryPressure", is_optional: false },
    :metric_nodes => { kind: :method, name: "metricNodes", is_optional: false },
    :metric_searchable_documents => { kind: :method, name: "metricSearchableDocuments", is_optional: false },
    :metric_search_latency => { kind: :method, name: "metricSearchLatency", is_optional: false },
  }
end

Instance Method Details

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

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).

Parameters:



99
100
101
102
 
# File 'open_search_service/i_domain.rb', line 99

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#domain_arn ⇒ String

Arn of the Amazon OpenSearch Service domain.

Returns:

  • (String) 


48
49
50
 
# File 'open_search_service/i_domain.rb', line 48

def domain_arn()
  jsii_get_property("domainArn")
end

#domain_endpoint ⇒ String

Endpoint of the Amazon OpenSearch Service domain.

Returns:

  • (String) 


55
56
57
 
# File 'open_search_service/i_domain.rb', line 55

def domain_endpoint()
  jsii_get_property("domainEndpoint")
end

#domain_id ⇒ String

Identifier of the Amazon OpenSearch Service domain.

Returns:

  • (String) 


62
63
64
 
# File 'open_search_service/i_domain.rb', line 62

def domain_id()
  jsii_get_property("domainId")
end

#domain_name ⇒ String

Domain name of the Amazon OpenSearch Service domain.

Returns:

  • (String) 


69
70
71
 
# File 'open_search_service/i_domain.rb', line 69

def domain_name()
  jsii_get_property("domainName")
end

#domain_ref ⇒ AWSCDK::Interfaces::AWSOpensearchservice::DomainReference

A reference to a Domain resource.

Returns:



41
42
43
 
# File 'open_search_service/i_domain.rb', line 41

def domain_ref()
  jsii_get_property("domainRef")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



27
28
29
 
# File 'open_search_service/i_domain.rb', line 27

def env()
  jsii_get_property("env")
end

#grant_index_read(index, identity) ⇒ AWSCDK::IAM::Grant

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

Parameters:

Returns:



109
110
111
112
113
 
# File 'open_search_service/i_domain.rb', line 109

def grant_index_read(index, identity)
  Jsii::Type.check_type(index, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "index")
  Jsii::Type.check_type(identity, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "identity")
  jsii_call_method("grantIndexRead", [index, identity])
end

#grant_index_read_write(index, identity) ⇒ AWSCDK::IAM::Grant

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

Parameters:

Returns:



120
121
122
123
124
 
# File 'open_search_service/i_domain.rb', line 120

def grant_index_read_write(index, identity)
  Jsii::Type.check_type(index, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "index")
  Jsii::Type.check_type(identity, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "identity")
  jsii_call_method("grantIndexReadWrite", [index, identity])
end

#grant_index_write(index, identity) ⇒ AWSCDK::IAM::Grant

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

Parameters:

Returns:



131
132
133
134
135
 
# File 'open_search_service/i_domain.rb', line 131

def grant_index_write(index, identity)
  Jsii::Type.check_type(index, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "index")
  Jsii::Type.check_type(identity, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "identity")
  jsii_call_method("grantIndexWrite", [index, identity])
end

#grant_path_read(path, identity) ⇒ AWSCDK::IAM::Grant

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

Parameters:

Returns:



142
143
144
145
146
 
# File 'open_search_service/i_domain.rb', line 142

def grant_path_read(path, identity)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(identity, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "identity")
  jsii_call_method("grantPathRead", [path, identity])
end

#grant_path_read_write(path, identity) ⇒ AWSCDK::IAM::Grant

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

Parameters:

Returns:



153
154
155
156
157
 
# File 'open_search_service/i_domain.rb', line 153

def grant_path_read_write(path, identity)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(identity, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "identity")
  jsii_call_method("grantPathReadWrite", [path, identity])
end

#grant_path_write(path, identity) ⇒ AWSCDK::IAM::Grant

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

Parameters:

Returns:



164
165
166
167
168
 
# File 'open_search_service/i_domain.rb', line 164

def grant_path_write(path, identity)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(identity, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "identity")
  jsii_call_method("grantPathWrite", [path, identity])
end

#grant_read(identity) ⇒ AWSCDK::IAM::Grant

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

Parameters:

Returns:



174
175
176
177
 
# File 'open_search_service/i_domain.rb', line 174

def grant_read(identity)
  Jsii::Type.check_type(identity, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "identity")
  jsii_call_method("grantRead", [identity])
end

#grant_read_write(identity) ⇒ AWSCDK::IAM::Grant

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

Parameters:

Returns:



183
184
185
186
 
# File 'open_search_service/i_domain.rb', line 183

def grant_read_write(identity)
  Jsii::Type.check_type(identity, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "identity")
  jsii_call_method("grantReadWrite", [identity])
end

#grant_write(identity) ⇒ AWSCDK::IAM::Grant

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

Parameters:

Returns:



192
193
194
195
 
# File 'open_search_service/i_domain.rb', line 192

def grant_write(identity)
  Jsii::Type.check_type(identity, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "identity")
  jsii_call_method("grantWrite", [identity])
end

#metric(metric_name, props = nil) ⇒ AWSCDK::CloudWatch::Metric

Return the given named metric for this domain.

Parameters:

Returns:



202
203
204
205
206
207
 
# File 'open_search_service/i_domain.rb', line 202

def metric(metric_name, props = nil)
  Jsii::Type.check_type(metric_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metricName")
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metric", [metric_name, props])
end

#metric_automated_snapshot_failure(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: maximum over 5 minutes

Metric for automated snapshot failures.

Parameters:

Returns:



214
215
216
217
218
 
# File 'open_search_service/i_domain.rb', line 214

def metric_automated_snapshot_failure(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricAutomatedSnapshotFailure", [props])
end

#metric_cluster_index_writes_blocked(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: maximum over 1 minute

Metric for the cluster blocking index writes.

Parameters:

Returns:



225
226
227
228
229
 
# File 'open_search_service/i_domain.rb', line 225

def metric_cluster_index_writes_blocked(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricClusterIndexWritesBlocked", [props])
end

#metric_cluster_status_red(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: maximum over 5 minutes

Metric for the time the cluster status is red.

Parameters:

Returns:



236
237
238
239
240
 
# File 'open_search_service/i_domain.rb', line 236

def metric_cluster_status_red(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricClusterStatusRed", [props])
end

#metric_cluster_status_yellow(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: maximum over 5 minutes

Metric for the time the cluster status is yellow.

Parameters:

Returns:



247
248
249
250
251
 
# File 'open_search_service/i_domain.rb', line 247

def metric_cluster_status_yellow(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricClusterStatusYellow", [props])
end

#metric_cpu_utilization(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: maximum over 5 minutes

Metric for CPU utilization.

Parameters:

Returns:



258
259
260
261
262
 
# File 'open_search_service/i_domain.rb', line 258

def metric_cpu_utilization(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricCPUUtilization", [props])
end

#metric_free_storage_space(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: minimum over 5 minutes

Metric for the storage space of nodes in the cluster.

Parameters:

Returns:



269
270
271
272
273
 
# File 'open_search_service/i_domain.rb', line 269

def metric_free_storage_space(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricFreeStorageSpace", [props])
end

#metric_indexing_latency(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: p99 over 5 minutes

Metric for indexing latency.

Parameters:

Returns:



280
281
282
283
284
 
# File 'open_search_service/i_domain.rb', line 280

def metric_indexing_latency(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricIndexingLatency", [props])
end

#metric_jvm_memory_pressure(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: maximum over 5 minutes

Metric for JVM memory pressure.

Parameters:

Returns:



291
292
293
294
295
 
# File 'open_search_service/i_domain.rb', line 291

def metric_jvm_memory_pressure(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricJVMMemoryPressure", [props])
end

#metric_kms_key_error(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: maximum over 5 minutes

Metric for KMS key errors.

Parameters:

Returns:



302
303
304
305
306
 
# File 'open_search_service/i_domain.rb', line 302

def metric_kms_key_error(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricKMSKeyError", [props])
end

#metric_kms_key_inaccessible(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: maximum over 5 minutes

Metric for KMS key being inaccessible.

Parameters:

Returns:



313
314
315
316
317
 
# File 'open_search_service/i_domain.rb', line 313

def metric_kms_key_inaccessible(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricKMSKeyInaccessible", [props])
end

#metric_master_cpu_utilization(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: maximum over 5 minutes

Metric for master CPU utilization.

Parameters:

Returns:



324
325
326
327
328
 
# File 'open_search_service/i_domain.rb', line 324

def metric_master_cpu_utilization(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricMasterCPUUtilization", [props])
end

#metric_master_jvm_memory_pressure(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: maximum over 5 minutes

Metric for master JVM memory pressure.

Parameters:

Returns:



335
336
337
338
339
 
# File 'open_search_service/i_domain.rb', line 335

def metric_master_jvm_memory_pressure(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricMasterJVMMemoryPressure", [props])
end

#metric_nodes(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: minimum over 1 hour

Metric for the number of nodes.

Parameters:

Returns:



346
347
348
349
350
 
# File 'open_search_service/i_domain.rb', line 346

def metric_nodes(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricNodes", [props])
end

#metric_search_latency(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: p99 over 5 minutes

Metric for search latency.

Parameters:

Returns:



368
369
370
371
372
 
# File 'open_search_service/i_domain.rb', line 368

def metric_search_latency(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricSearchLatency", [props])
end

#metric_searchable_documents(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: maximum over 5 minutes

Metric for number of searchable documents.

Parameters:

Returns:



357
358
359
360
361
 
# File 'open_search_service/i_domain.rb', line 357

def metric_searchable_documents(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricSearchableDocuments", [props])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


12
13
14
 
# File 'open_search_service/i_domain.rb', line 12

def node()
  jsii_get_property("node")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



34
35
36
 
# File 'open_search_service/i_domain.rb', line 34

def stack()
  jsii_get_property("stack")
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



80
81
82
83
84
85
 
# File 'open_search_service/i_domain.rb', line 80

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end