Class: AWSCDK::Elasticsearch::Domain Deprecated

Inherits:
Resource
  • Object
show all
Includes:
AWSCDK::EC2::IConnectable, IDomain
Defined in:
elasticsearch/domain.rb

Overview

Deprecated.

use opensearchservice module instead

Provides an Elasticsearch domain.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ Domain

Returns a new instance of Domain.

Parameters:



15
16
17
18
19
20
21
 
# File 'elasticsearch/domain.rb', line 15

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Elasticsearch::DomainProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY3NlYXJjaC5Eb21haW5Qcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_domain_attributes(scope, id, attrs) ⇒ AWSCDK::Elasticsearch::IDomain

Deprecated.

use opensearchservice module instead

Creates a Domain construct that represents an external domain.

Parameters:

  • scope (Constructs::Construct) —

    The parent creating construct (usually this).

  • id (String) —

    The construct's name.

  • attrs (AWSCDK::Elasticsearch::DomainAttributes) —

    A DomainAttributes object.

Returns:



83
84
85
86
87
88
89
 
# File 'elasticsearch/domain.rb', line 83

def self.from_domain_attributes(scope, id, attrs)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  attrs = attrs.is_a?(Hash) ? ::AWSCDK::Elasticsearch::DomainAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY3NlYXJjaC5Eb21haW5BdHRyaWJ1dGVzIn0=")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_elasticsearch.Domain", "fromDomainAttributes", [scope, id, attrs])
end

.from_domain_endpoint(scope, id, domain_endpoint) ⇒ AWSCDK::Elasticsearch::IDomain

Deprecated.

use opensearchservice module instead

Creates a Domain construct that represents an external domain via domain endpoint.

Parameters:

  • scope (Constructs::Construct) —

    The parent creating construct (usually this).

  • id (String) —

    The construct's name.

  • domain_endpoint (String) —

    The domain's endpoint.

Returns:



98
99
100
101
102
103
 
# File 'elasticsearch/domain.rb', line 98

def self.from_domain_endpoint(scope, id, domain_endpoint)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(domain_endpoint, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainEndpoint")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_elasticsearch.Domain", "fromDomainEndpoint", [scope, id, domain_endpoint])
end

.jsii_overridable_methods ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'elasticsearch/domain.rb', line 23

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :connections => { kind: :property, name: "connections", is_optional: false },
    :domain_arn => { kind: :property, name: "domainArn", is_optional: false },
    :domain_endpoint => { kind: :property, name: "domainEndpoint", is_optional: false },
    :domain_name => { kind: :property, name: "domainName", is_optional: false },
    :domain_ref => { kind: :property, name: "domainRef", is_optional: false },
    :grants => { kind: :property, name: "grants", is_optional: false },
    :app_log_group => { kind: :property, name: "appLogGroup", is_optional: true },
    :audit_log_group => { kind: :property, name: "auditLogGroup", is_optional: true },
    :master_user_password => { kind: :property, name: "masterUserPassword", is_optional: true },
    :slow_index_log_group => { kind: :property, name: "slowIndexLogGroup", is_optional: true },
    :slow_search_log_group => { kind: :property, name: "slowSearchLogGroup", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :add_access_policies => { kind: :method, name: "addAccessPolicies", 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

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


151
152
153
 
# File 'elasticsearch/domain.rb', line 151

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_elasticsearch.Domain", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#add_access_policies(*access_policy_statements) ⇒ void

Deprecated.

use opensearchservice module instead

This method returns an undefined value.

Add policy statements to the domain access policy.

Parameters:



337
338
339
340
341
342
 
# File 'elasticsearch/domain.rb', line 337

def add_access_policies(*access_policy_statements)
  access_policy_statements.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLlBvbGljeVN0YXRlbWVudCJ9")), "accessPolicyStatements[#{index}]")
  end
  jsii_call_method("addAccessPolicies", [*access_policy_statements])
end

#app_log_group ⇒ AWSCDK::Logs::ILogGroup?

Deprecated.

use opensearchservice module instead

Log group that application logs are logged to.

Returns:



206
207
208
 
# File 'elasticsearch/domain.rb', line 206

def app_log_group()
  jsii_get_property("appLogGroup")
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



275
276
277
278
 
# File 'elasticsearch/domain.rb', line 275

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#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:



292
293
294
295
 
# File 'elasticsearch/domain.rb', line 292

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

#audit_log_group ⇒ AWSCDK::Logs::ILogGroup?

Deprecated.

use opensearchservice module instead

Log group that audit logs are logged to.

Returns:



214
215
216
 
# File 'elasticsearch/domain.rb', line 214

def audit_log_group()
  jsii_get_property("auditLogGroup")
end

#connections ⇒ AWSCDK::EC2::Connections

Deprecated.

use opensearchservice module instead

Manages network connections to the domain.

This will throw an error in case the domain is not placed inside a VPC.

Returns:



162
163
164
 
# File 'elasticsearch/domain.rb', line 162

def connections()
  jsii_get_property("connections")
end

#domain_arn ⇒ String

Arn of the Elasticsearch domain.

Returns:

  • (String) 


169
170
171
 
# File 'elasticsearch/domain.rb', line 169

def domain_arn()
  jsii_get_property("domainArn")
end

#domain_endpoint ⇒ String

Deprecated.

use opensearchservice module instead

Endpoint of the Elasticsearch domain.

Returns:

  • (String) 


177
178
179
 
# File 'elasticsearch/domain.rb', line 177

def domain_endpoint()
  jsii_get_property("domainEndpoint")
end

#domain_name ⇒ String

Domain name of the Elasticsearch domain.

Returns:

  • (String) 


184
185
186
 
# File 'elasticsearch/domain.rb', line 184

def domain_name()
  jsii_get_property("domainName")
end

#domain_ref ⇒ AWSCDK::Interfaces::AWSElasticsearch::DomainReference

A reference to a Domain resource.

Returns:



191
192
193
 
# File 'elasticsearch/domain.rb', line 191

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:



123
124
125
 
# File 'elasticsearch/domain.rb', line 123

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


298
299
300
 
# File 'elasticsearch/domain.rb', line 298

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


312
313
314
315
316
317
 
# File 'elasticsearch/domain.rb', line 312

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


327
328
329
330
 
# File 'elasticsearch/domain.rb', line 327

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

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

Deprecated.

use opensearchservice module instead

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

[disable-awslint:no-grants]

Parameters:

Returns:



352
353
354
355
356
 
# File 'elasticsearch/domain.rb', line 352

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

Deprecated.

use opensearchservice module instead

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

[disable-awslint:no-grants]

Parameters:

Returns:



366
367
368
369
370
 
# File 'elasticsearch/domain.rb', line 366

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

Deprecated.

use opensearchservice module instead

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

[disable-awslint:no-grants]

Parameters:

Returns:



380
381
382
383
384
 
# File 'elasticsearch/domain.rb', line 380

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

Deprecated.

use opensearchservice module instead

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

[disable-awslint:no-grants]

Parameters:

Returns:



394
395
396
397
398
 
# File 'elasticsearch/domain.rb', line 394

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

Deprecated.

use opensearchservice module instead

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

[disable-awslint:no-grants]

Parameters:

Returns:



408
409
410
411
412
 
# File 'elasticsearch/domain.rb', line 408

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

Deprecated.

use opensearchservice module instead

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

[disable-awslint:no-grants]

Parameters:

Returns:



422
423
424
425
426
 
# File 'elasticsearch/domain.rb', line 422

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

Deprecated.

use opensearchservice module instead

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

[disable-awslint:no-grants]

Parameters:

Returns:



435
436
437
438
 
# File 'elasticsearch/domain.rb', line 435

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

Deprecated.

use opensearchservice module instead

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

[disable-awslint:no-grants]

Parameters:

Returns:



447
448
449
450
 
# File 'elasticsearch/domain.rb', line 447

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

Deprecated.

use opensearchservice module instead

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

[disable-awslint:no-grants]

Parameters:

Returns:



459
460
461
462
 
# File 'elasticsearch/domain.rb', line 459

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

#grants ⇒ AWSCDK::Elasticsearch::DomainGrants

Collection of grant methods for a Domain.

Returns:



198
199
200
 
# File 'elasticsearch/domain.rb', line 198

def grants()
  jsii_get_property("grants")
end

#master_user_password ⇒ AWSCDK::SecretValue?

Deprecated.

use opensearchservice module instead

Master user password if fine grained access control is configured.

Returns:



222
223
224
 
# File 'elasticsearch/domain.rb', line 222

def master_user_password()
  jsii_get_property("masterUserPassword")
end

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

Deprecated.

use opensearchservice module instead

Return the given named metric for this Domain.

Parameters:

Returns:



470
471
472
473
474
475
 
# File 'elasticsearch/domain.rb', line 470

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

Deprecated.

use opensearchservice module instead

Note:

Default: maximum over 5 minutes

Metric for automated snapshot failures.

Parameters:

Returns:



483
484
485
486
487
 
# File 'elasticsearch/domain.rb', line 483

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

Deprecated.

use opensearchservice module instead

Note:

Default: maximum over 1 minute

Metric for the cluster blocking index writes.

Parameters:

Returns:



495
496
497
498
499
 
# File 'elasticsearch/domain.rb', line 495

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

Deprecated.

use opensearchservice module instead

Note:

Default: maximum over 5 minutes

Metric for the time the cluster status is red.

Parameters:

Returns:



507
508
509
510
511
 
# File 'elasticsearch/domain.rb', line 507

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

Deprecated.

use opensearchservice module instead

Note:

Default: maximum over 5 minutes

Metric for the time the cluster status is yellow.

Parameters:

Returns:



519
520
521
522
523
 
# File 'elasticsearch/domain.rb', line 519

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

Deprecated.

use opensearchservice module instead

Note:

Default: maximum over 5 minutes

Metric for CPU utilization.

Parameters:

Returns:



531
532
533
534
535
 
# File 'elasticsearch/domain.rb', line 531

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

Deprecated.

use opensearchservice module instead

Note:

Default: minimum over 5 minutes

Metric for the storage space of nodes in the cluster.

Parameters:

Returns:



543
544
545
546
547
 
# File 'elasticsearch/domain.rb', line 543

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

Deprecated.

use opensearchservice module instead

Note:

Default: p99 over 5 minutes

Metric for indexing latency.

Parameters:

Returns:



555
556
557
558
559
 
# File 'elasticsearch/domain.rb', line 555

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

Deprecated.

use opensearchservice module instead

Note:

Default: maximum over 5 minutes

Metric for JVM memory pressure.

Parameters:

Returns:



567
568
569
570
571
 
# File 'elasticsearch/domain.rb', line 567

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

Deprecated.

use opensearchservice module instead

Note:

Default: maximum over 5 minutes

Metric for KMS key errors.

Parameters:

Returns:



579
580
581
582
583
 
# File 'elasticsearch/domain.rb', line 579

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

Deprecated.

use opensearchservice module instead

Note:

Default: maximum over 5 minutes

Metric for KMS key being inaccessible.

Parameters:

Returns:



591
592
593
594
595
 
# File 'elasticsearch/domain.rb', line 591

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

Deprecated.

use opensearchservice module instead

Note:

Default: maximum over 5 minutes

Metric for master CPU utilization.

Parameters:

Returns:



603
604
605
606
607
 
# File 'elasticsearch/domain.rb', line 603

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

Deprecated.

use opensearchservice module instead

Note:

Default: maximum over 5 minutes

Metric for master JVM memory pressure.

Parameters:

Returns:



615
616
617
618
619
 
# File 'elasticsearch/domain.rb', line 615

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

Deprecated.

use opensearchservice module instead

Note:

Default: minimum over 1 hour

Metric for the number of nodes.

Parameters:

Returns:



627
628
629
630
631
 
# File 'elasticsearch/domain.rb', line 627

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

Deprecated.

use opensearchservice module instead

Note:

Default: p99 over 5 minutes

Metric for search latency.

Parameters:

Returns:



651
652
653
654
655
 
# File 'elasticsearch/domain.rb', line 651

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

Deprecated.

use opensearchservice module instead

Note:

Default: maximum over 5 minutes

Metric for number of searchable documents.

Parameters:

Returns:



639
640
641
642
643
 
# File 'elasticsearch/domain.rb', line 639

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) 


108
109
110
 
# File 'elasticsearch/domain.rb', line 108

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


137
138
139
 
# File 'elasticsearch/domain.rb', line 137

def physical_name()
  jsii_get_property("physicalName")
end

#slow_index_log_group ⇒ AWSCDK::Logs::ILogGroup?

Deprecated.

use opensearchservice module instead

Log group that slow indices are logged to.

Returns:



230
231
232
 
# File 'elasticsearch/domain.rb', line 230

def slow_index_log_group()
  jsii_get_property("slowIndexLogGroup")
end

#slow_search_log_group ⇒ AWSCDK::Logs::ILogGroup?

Deprecated.

use opensearchservice module instead

Log group that slow searches are logged to.

Returns:



238
239
240
 
# File 'elasticsearch/domain.rb', line 238

def slow_search_log_group()
  jsii_get_property("slowSearchLogGroup")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



144
145
146
 
# File 'elasticsearch/domain.rb', line 144

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


245
246
247
 
# File 'elasticsearch/domain.rb', line 245

def to_string()
  jsii_call_method("toString", [])
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. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


258
259
260
261
262
263
 
# File 'elasticsearch/domain.rb', line 258

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