Class: AWSCDK::OpenSearchService::CfnDomain

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSOpensearchservice::IDomainRef
Defined in:
open_search_service/cfn_domain.rb

Overview

The AWS::OpenSearchService::Domain resource creates an Amazon OpenSearch Service domain.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ CfnDomain

Create a new AWS::OpenSearchService::Domain.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::OpenSearchService::CfnDomainProps, nil) (defaults to: nil) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'open_search_service/cfn_domain.rb', line 18

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::OpenSearchService::CfnDomainProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfb3BlbnNlYXJjaHNlcnZpY2UuQ2ZuRG9tYWluUHJvcHMifQ==")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_domain(resource) ⇒ String

Parameters:

Returns:

  • (String) 


111
112
113
114
 
# File 'open_search_service/cfn_domain.rb', line 111

def self.arn_for_domain(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19vcGVuc2VhcmNoc2VydmljZS5JRG9tYWluUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_opensearchservice.CfnDomain", "arnForDomain", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


244
245
246
 
# File 'open_search_service/cfn_domain.rb', line 244

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_opensearchservice.CfnDomain", "CFN_RESOURCE_TYPE_NAME")
end

.from_domain_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSOpensearchservice::IDomainRef

Creates a new IDomainRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



122
123
124
125
126
127
 
# File 'open_search_service/cfn_domain.rb', line 122

def self.from_domain_arn(scope, id, arn)
  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(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_opensearchservice.CfnDomain", "fromDomainArn", [scope, id, arn])
end

.from_domain_name(scope, id, domain_name) ⇒ AWSCDK::Interfaces::AWSOpensearchservice::IDomainRef

Creates a new IDomainRef from a domainName.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • domain_name (String)

Returns:



135
136
137
138
139
140
 
# File 'open_search_service/cfn_domain.rb', line 135

def self.from_domain_name(scope, id, domain_name)
  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_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_opensearchservice.CfnDomain", "fromDomainName", [scope, id, domain_name])
end

.is_cfn_domain(x) ⇒ Boolean

Checks whether the given object is a CfnDomain.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


146
147
148
149
 
# File 'open_search_service/cfn_domain.rb', line 146

def self.is_cfn_domain(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_opensearchservice.CfnDomain", "isCfnDomain", [x])
end

.jsii_overridable_methods ⇒ Object 



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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'open_search_service/cfn_domain.rb', line 26

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_advanced_security_options_anonymous_auth_disable_date => { kind: :property, name: "attrAdvancedSecurityOptionsAnonymousAuthDisableDate", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_domain_endpoint => { kind: :property, name: "attrDomainEndpoint", is_optional: false },
    :attr_domain_endpoints => { kind: :property, name: "attrDomainEndpoints", is_optional: false },
    :attr_domain_endpoint_v2 => { kind: :property, name: "attrDomainEndpointV2", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_identity_center_options_identity_center_application_arn => { kind: :property, name: "attrIdentityCenterOptionsIdentityCenterApplicationArn", is_optional: false },
    :attr_identity_center_options_identity_store_id => { kind: :property, name: "attrIdentityCenterOptionsIdentityStoreId", is_optional: false },
    :attr_service_software_options => { kind: :property, name: "attrServiceSoftwareOptions", is_optional: false },
    :attr_service_software_options_automated_update_date => { kind: :property, name: "attrServiceSoftwareOptionsAutomatedUpdateDate", is_optional: false },
    :attr_service_software_options_cancellable => { kind: :property, name: "attrServiceSoftwareOptionsCancellable", is_optional: false },
    :attr_service_software_options_current_version => { kind: :property, name: "attrServiceSoftwareOptionsCurrentVersion", is_optional: false },
    :attr_service_software_options_description => { kind: :property, name: "attrServiceSoftwareOptionsDescription", is_optional: false },
    :attr_service_software_options_new_version => { kind: :property, name: "attrServiceSoftwareOptionsNewVersion", is_optional: false },
    :attr_service_software_options_optional_deployment => { kind: :property, name: "attrServiceSoftwareOptionsOptionalDeployment", is_optional: false },
    :attr_service_software_options_update_available => { kind: :property, name: "attrServiceSoftwareOptionsUpdateAvailable", is_optional: false },
    :attr_service_software_options_update_status => { kind: :property, name: "attrServiceSoftwareOptionsUpdateStatus", is_optional: false },
    :domain_ref => { kind: :property, name: "domainRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :access_policies => { kind: :property, name: "accessPolicies", is_optional: false },
    :advanced_options => { kind: :property, name: "advancedOptions", is_optional: true },
    :advanced_security_options => { kind: :property, name: "advancedSecurityOptions", is_optional: true },
    :aiml_options => { kind: :property, name: "aimlOptions", is_optional: true },
    :automated_snapshot_pause_options => { kind: :property, name: "automatedSnapshotPauseOptions", is_optional: true },
    :cluster_config => { kind: :property, name: "clusterConfig", is_optional: true },
    :cognito_options => { kind: :property, name: "cognitoOptions", is_optional: true },
    :deployment_strategy_options => { kind: :property, name: "deploymentStrategyOptions", is_optional: true },
    :domain_arn => { kind: :property, name: "domainArn", is_optional: true },
    :domain_endpoint_options => { kind: :property, name: "domainEndpointOptions", is_optional: true },
    :domain_name => { kind: :property, name: "domainName", is_optional: true },
    :ebs_options => { kind: :property, name: "ebsOptions", is_optional: true },
    :encryption_at_rest_options => { kind: :property, name: "encryptionAtRestOptions", is_optional: true },
    :engine_version => { kind: :property, name: "engineVersion", is_optional: true },
    :identity_center_options => { kind: :property, name: "identityCenterOptions", is_optional: true },
    :ip_address_type => { kind: :property, name: "ipAddressType", is_optional: true },
    :log_publishing_options => { kind: :property, name: "logPublishingOptions", is_optional: true },
    :node_to_node_encryption_options => { kind: :property, name: "nodeToNodeEncryptionOptions", is_optional: true },
    :off_peak_window_options => { kind: :property, name: "offPeakWindowOptions", is_optional: true },
    :skip_shard_migration_wait => { kind: :property, name: "skipShardMigrationWait", is_optional: true },
    :snapshot_options => { kind: :property, name: "snapshotOptions", is_optional: true },
    :software_update_options => { kind: :property, name: "softwareUpdateOptions", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :vpc_options => { kind: :property, name: "vpcOptions", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", 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 },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#access_policies ⇒ Object

An AWS Identity and Access Management ( IAM ) policy document that specifies who can access the OpenSearch Service domain and their permissions.

Returns:

  • (Object) 


370
371
372
 
# File 'open_search_service/cfn_domain.rb', line 370

def access_policies()
  jsii_get_property("accessPolicies")
end

#access_policies=(value) ⇒ Object 



374
375
376
377
 
# File 'open_search_service/cfn_domain.rb', line 374

def access_policies=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "accessPolicies")
  jsii_set_property("accessPolicies", value)
end

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



699
700
701
702
 
# File 'open_search_service/cfn_domain.rb', line 699

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



711
712
713
714
 
# File 'open_search_service/cfn_domain.rb', line 711

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



721
722
723
724
 
# File 'open_search_service/cfn_domain.rb', line 721

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



732
733
734
735
736
 
# File 'open_search_service/cfn_domain.rb', line 732

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


789
790
791
792
793
 
# File 'open_search_service/cfn_domain.rb', line 789

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



799
800
801
802
 
# File 'open_search_service/cfn_domain.rb', line 799

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



811
812
813
814
815
 
# File 'open_search_service/cfn_domain.rb', line 811

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#advanced_options ⇒ AWSCDK::IResolvable, ...

Additional options to specify for the OpenSearch Service domain.

Returns:



382
383
384
 
# File 'open_search_service/cfn_domain.rb', line 382

def advanced_options()
  jsii_get_property("advancedOptions")
end

#advanced_options=(value) ⇒ Object 



386
387
388
389
 
# File 'open_search_service/cfn_domain.rb', line 386

def advanced_options=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsicHJpbWl0aXZlIjoic3RyaW5nIn0sImtpbmQiOiJtYXAifX1dfX0=")), "advancedOptions") unless value.nil?
  jsii_set_property("advancedOptions", value)
end

#advanced_security_options ⇒ AWSCDK::IResolvable, ...

Specifies options for fine-grained access control and SAML authentication.

Returns:



394
395
396
 
# File 'open_search_service/cfn_domain.rb', line 394

def advanced_security_options()
  jsii_get_property("advancedSecurityOptions")
end

#advanced_security_options=(value) ⇒ Object 



398
399
400
401
402
 
# File 'open_search_service/cfn_domain.rb', line 398

def advanced_security_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::OpenSearchService::CfnDomain::AdvancedSecurityOptionsInputProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmljZS5DZm5Eb21haW4uQWR2YW5jZWRTZWN1cml0eU9wdGlvbnNJbnB1dFByb3BlcnR5In1dfX0=")), "advancedSecurityOptions") unless value.nil?
  jsii_set_property("advancedSecurityOptions", value)
end

#aiml_options ⇒ AWSCDK::IResolvable, ...

Container for parameters required to enable all machine learning features.

Returns:



407
408
409
 
# File 'open_search_service/cfn_domain.rb', line 407

def aiml_options()
  jsii_get_property("aimlOptions")
end

#aiml_options=(value) ⇒ Object 



411
412
413
414
415
 
# File 'open_search_service/cfn_domain.rb', line 411

def aiml_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::OpenSearchService::CfnDomain::AIMLOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmljZS5DZm5Eb21haW4uQUlNTE9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "aimlOptions") unless value.nil?
  jsii_set_property("aimlOptions", value)
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



824
825
826
827
 
# File 'open_search_service/cfn_domain.rb', line 824

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 = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



846
847
848
849
850
851
 
# File 'open_search_service/cfn_domain.rb', line 846

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_advanced_security_options_anonymous_auth_disable_date ⇒ String

Date and time when the migration period will be disabled.

Only necessary when enabling fine-grained access control on an existing domain .

Returns:

  • (String) 


253
254
255
 
# File 'open_search_service/cfn_domain.rb', line 253

def attr_advanced_security_options_anonymous_auth_disable_date()
  jsii_get_property("attrAdvancedSecurityOptionsAnonymousAuthDisableDate")
end

#attr_arn ⇒ String

The Amazon Resource Name (ARN) of the CloudFormation stack.

Returns:

  • (String) 


260
261
262
 
# File 'open_search_service/cfn_domain.rb', line 260

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_domain_endpoint ⇒ String

The domain-specific endpoint used for requests to the OpenSearch APIs, such as search-mystack-1ab2cdefghij-ab1c2deckoyb3hofw7wpqa3cm.us-west-1.es.amazonaws.com .

Returns:

  • (String) 


267
268
269
 
# File 'open_search_service/cfn_domain.rb', line 267

def attr_domain_endpoint()
  jsii_get_property("attrDomainEndpoint")
end

#attr_domain_endpoint_v2 ⇒ String

If IPAddressType to set to dualstack , a version 2 domain endpoint is provisioned.

This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses.

Returns:

  • (String) 


281
282
283
 
# File 'open_search_service/cfn_domain.rb', line 281

def attr_domain_endpoint_v2()
  jsii_get_property("attrDomainEndpointV2")
end

#attr_domain_endpoints ⇒ AWSCDK::IResolvable

Returns:



272
273
274
 
# File 'open_search_service/cfn_domain.rb', line 272

def attr_domain_endpoints()
  jsii_get_property("attrDomainEndpoints")
end

#attr_id ⇒ String

The resource ID.

For example, 123456789012/my-domain .

Returns:

  • (String) 


290
291
292
 
# File 'open_search_service/cfn_domain.rb', line 290

def attr_id()
  jsii_get_property("attrId")
end

#attr_identity_center_options_identity_center_application_arn ⇒ String

The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch Service.

Returns:

  • (String) 


297
298
299
 
# File 'open_search_service/cfn_domain.rb', line 297

def attr_identity_center_options_identity_center_application_arn()
  jsii_get_property("attrIdentityCenterOptionsIdentityCenterApplicationArn")
end

#attr_identity_center_options_identity_store_id ⇒ String

The identifier of the IAM Identity Store.

Returns:

  • (String) 


304
305
306
 
# File 'open_search_service/cfn_domain.rb', line 304

def attr_identity_center_options_identity_store_id()
  jsii_get_property("attrIdentityCenterOptionsIdentityStoreId")
end

#attr_service_software_options ⇒ AWSCDK::IResolvable

Returns:



309
310
311
 
# File 'open_search_service/cfn_domain.rb', line 309

def attr_service_software_options()
  jsii_get_property("attrServiceSoftwareOptions")
end

#attr_service_software_options_automated_update_date ⇒ String

Returns:

  • (String) 


314
315
316
 
# File 'open_search_service/cfn_domain.rb', line 314

def attr_service_software_options_automated_update_date()
  jsii_get_property("attrServiceSoftwareOptionsAutomatedUpdateDate")
end

#attr_service_software_options_cancellable ⇒ AWSCDK::IResolvable

Returns:



319
320
321
 
# File 'open_search_service/cfn_domain.rb', line 319

def attr_service_software_options_cancellable()
  jsii_get_property("attrServiceSoftwareOptionsCancellable")
end

#attr_service_software_options_current_version ⇒ String

Returns:

  • (String) 


324
325
326
 
# File 'open_search_service/cfn_domain.rb', line 324

def attr_service_software_options_current_version()
  jsii_get_property("attrServiceSoftwareOptionsCurrentVersion")
end

#attr_service_software_options_description ⇒ String

Returns:

  • (String) 


329
330
331
 
# File 'open_search_service/cfn_domain.rb', line 329

def attr_service_software_options_description()
  jsii_get_property("attrServiceSoftwareOptionsDescription")
end

#attr_service_software_options_new_version ⇒ String

Returns:

  • (String) 


334
335
336
 
# File 'open_search_service/cfn_domain.rb', line 334

def attr_service_software_options_new_version()
  jsii_get_property("attrServiceSoftwareOptionsNewVersion")
end

#attr_service_software_options_optional_deployment ⇒ AWSCDK::IResolvable

Returns:



339
340
341
 
# File 'open_search_service/cfn_domain.rb', line 339

def attr_service_software_options_optional_deployment()
  jsii_get_property("attrServiceSoftwareOptionsOptionalDeployment")
end

#attr_service_software_options_update_available ⇒ AWSCDK::IResolvable

Returns:



344
345
346
 
# File 'open_search_service/cfn_domain.rb', line 344

def attr_service_software_options_update_available()
  jsii_get_property("attrServiceSoftwareOptionsUpdateAvailable")
end

#attr_service_software_options_update_status ⇒ String

Returns:

  • (String) 


349
350
351
 
# File 'open_search_service/cfn_domain.rb', line 349

def attr_service_software_options_update_status()
  jsii_get_property("attrServiceSoftwareOptionsUpdateStatus")
end

#automated_snapshot_pause_options ⇒ AWSCDK::IResolvable, ...

Returns:



418
419
420
 
# File 'open_search_service/cfn_domain.rb', line 418

def automated_snapshot_pause_options()
  jsii_get_property("automatedSnapshotPauseOptions")
end

#automated_snapshot_pause_options=(value) ⇒ Object 



422
423
424
425
426
 
# File 'open_search_service/cfn_domain.rb', line 422

def automated_snapshot_pause_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::OpenSearchService::CfnDomain::AutomatedSnapshotPauseOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmljZS5DZm5Eb21haW4uQXV0b21hdGVkU25hcHNob3RQYXVzZU9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "automatedSnapshotPauseOptions") unless value.nil?
  jsii_set_property("automatedSnapshotPauseOptions", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



197
198
199
 
# File 'open_search_service/cfn_domain.rb', line 197

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


202
203
204
 
# File 'open_search_service/cfn_domain.rb', line 202

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


855
856
857
858
 
# File 'open_search_service/cfn_domain.rb', line 855

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


207
208
209
 
# File 'open_search_service/cfn_domain.rb', line 207

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


214
215
216
 
# File 'open_search_service/cfn_domain.rb', line 214

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#cluster_config ⇒ AWSCDK::IResolvable, ...

Container for the cluster configuration of a domain.

Returns:



431
432
433
 
# File 'open_search_service/cfn_domain.rb', line 431

def cluster_config()
  jsii_get_property("clusterConfig")
end

#cluster_config=(value) ⇒ Object 



435
436
437
438
439
 
# File 'open_search_service/cfn_domain.rb', line 435

def cluster_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::OpenSearchService::CfnDomain::ClusterConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmljZS5DZm5Eb21haW4uQ2x1c3RlckNvbmZpZ1Byb3BlcnR5In1dfX0=")), "clusterConfig") unless value.nil?
  jsii_set_property("clusterConfig", value)
end

#cognito_options ⇒ AWSCDK::IResolvable, ...

Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.

Returns:



444
445
446
 
# File 'open_search_service/cfn_domain.rb', line 444

def cognito_options()
  jsii_get_property("cognitoOptions")
end

#cognito_options=(value) ⇒ Object 



448
449
450
451
452
 
# File 'open_search_service/cfn_domain.rb', line 448

def cognito_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::OpenSearchService::CfnDomain::CognitoOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmljZS5DZm5Eb21haW4uQ29nbml0b09wdGlvbnNQcm9wZXJ0eSJ9XX19")), "cognitoOptions") unless value.nil?
  jsii_set_property("cognitoOptions", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


159
160
161
 
# File 'open_search_service/cfn_domain.rb', line 159

def creation_stack()
  jsii_get_property("creationStack")
end

#deployment_strategy_options ⇒ AWSCDK::IResolvable, ...

Returns:



455
456
457
 
# File 'open_search_service/cfn_domain.rb', line 455

def deployment_strategy_options()
  jsii_get_property("deploymentStrategyOptions")
end

#deployment_strategy_options=(value) ⇒ Object 



459
460
461
462
463
 
# File 'open_search_service/cfn_domain.rb', line 459

def deployment_strategy_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::OpenSearchService::CfnDomain::DeploymentStrategyOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmljZS5DZm5Eb21haW4uRGVwbG95bWVudFN0cmF0ZWd5T3B0aW9uc1Byb3BlcnR5In1dfX0=")), "deploymentStrategyOptions") unless value.nil?
  jsii_set_property("deploymentStrategyOptions", value)
end

#domain_arn ⇒ String?

Returns:

  • (String, nil) 


466
467
468
 
# File 'open_search_service/cfn_domain.rb', line 466

def domain_arn()
  jsii_get_property("domainArn")
end

#domain_arn=(value) ⇒ Object 



470
471
472
473
 
# File 'open_search_service/cfn_domain.rb', line 470

def domain_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainArn") unless value.nil?
  jsii_set_property("domainArn", value)
end

#domain_endpoint_options ⇒ AWSCDK::IResolvable, ...

Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint.

Returns:



478
479
480
 
# File 'open_search_service/cfn_domain.rb', line 478

def domain_endpoint_options()
  jsii_get_property("domainEndpointOptions")
end

#domain_endpoint_options=(value) ⇒ Object 



482
483
484
485
486
 
# File 'open_search_service/cfn_domain.rb', line 482

def domain_endpoint_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::OpenSearchService::CfnDomain::DomainEndpointOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmljZS5DZm5Eb21haW4uRG9tYWluRW5kcG9pbnRPcHRpb25zUHJvcGVydHkifV19fQ==")), "domainEndpointOptions") unless value.nil?
  jsii_set_property("domainEndpointOptions", value)
end

#domain_name ⇒ String?

A name for the OpenSearch Service domain.

Returns:

  • (String, nil) 


491
492
493
 
# File 'open_search_service/cfn_domain.rb', line 491

def domain_name()
  jsii_get_property("domainName")
end

#domain_name=(value) ⇒ Object 



495
496
497
498
 
# File 'open_search_service/cfn_domain.rb', line 495

def domain_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainName") unless value.nil?
  jsii_set_property("domainName", value)
end

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

A reference to a Domain resource.

Returns:



356
357
358
 
# File 'open_search_service/cfn_domain.rb', line 356

def domain_ref()
  jsii_get_property("domainRef")
end

#ebs_options ⇒ AWSCDK::IResolvable, ...

The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.

Returns:



503
504
505
 
# File 'open_search_service/cfn_domain.rb', line 503

def ebs_options()
  jsii_get_property("ebsOptions")
end

#ebs_options=(value) ⇒ Object 



507
508
509
510
511
 
# File 'open_search_service/cfn_domain.rb', line 507

def ebs_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::OpenSearchService::CfnDomain::EBSOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmljZS5DZm5Eb21haW4uRUJTT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "ebsOptions") unless value.nil?
  jsii_set_property("ebsOptions", value)
end

#encryption_at_rest_options ⇒ AWSCDK::IResolvable, ...

Whether the domain should encrypt data at rest, and if so, the AWS key to use.

Returns:



516
517
518
 
# File 'open_search_service/cfn_domain.rb', line 516

def encryption_at_rest_options()
  jsii_get_property("encryptionAtRestOptions")
end

#encryption_at_rest_options=(value) ⇒ Object 



520
521
522
523
524
 
# File 'open_search_service/cfn_domain.rb', line 520

def encryption_at_rest_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::OpenSearchService::CfnDomain::EncryptionAtRestOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmljZS5DZm5Eb21haW4uRW5jcnlwdGlvbkF0UmVzdE9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "encryptionAtRestOptions") unless value.nil?
  jsii_set_property("encryptionAtRestOptions", value)
end

#engine_version ⇒ String?

The version of OpenSearch to use.

Returns:

  • (String, nil) 


529
530
531
 
# File 'open_search_service/cfn_domain.rb', line 529

def engine_version()
  jsii_get_property("engineVersion")
end

#engine_version=(value) ⇒ Object 



533
534
535
536
 
# File 'open_search_service/cfn_domain.rb', line 533

def engine_version=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "engineVersion") unless value.nil?
  jsii_set_property("engineVersion", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



219
220
221
 
# File 'open_search_service/cfn_domain.rb', line 219

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



868
869
870
871
872
 
# File 'open_search_service/cfn_domain.rb', line 868

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



879
880
881
882
 
# File 'open_search_service/cfn_domain.rb', line 879

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#identity_center_options ⇒ AWSCDK::IResolvable, ...

Configuration options for controlling IAM Identity Center integration within a domain.

Returns:



541
542
543
 
# File 'open_search_service/cfn_domain.rb', line 541

def identity_center_options()
  jsii_get_property("identityCenterOptions")
end

#identity_center_options=(value) ⇒ Object 



545
546
547
548
549
 
# File 'open_search_service/cfn_domain.rb', line 545

def identity_center_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::OpenSearchService::CfnDomain::IdentityCenterOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmljZS5DZm5Eb21haW4uSWRlbnRpdHlDZW50ZXJPcHRpb25zUHJvcGVydHkifV19fQ==")), "identityCenterOptions") unless value.nil?
  jsii_set_property("identityCenterOptions", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



949
950
951
952
 
# File 'open_search_service/cfn_domain.rb', line 949

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#ip_address_type ⇒ String?

Choose either dual stack or IPv4 as your IP address type.

Returns:

  • (String, nil) 


554
555
556
 
# File 'open_search_service/cfn_domain.rb', line 554

def ip_address_type()
  jsii_get_property("ipAddressType")
end

#ip_address_type=(value) ⇒ Object 



558
559
560
561
 
# File 'open_search_service/cfn_domain.rb', line 558

def ip_address_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ipAddressType") unless value.nil?
  jsii_set_property("ipAddressType", value)
end

#log_publishing_options ⇒ AWSCDK::IResolvable, ...

An object with one or more of the following keys: SEARCH_SLOW_LOGS , ES_APPLICATION_LOGS , INDEX_SLOW_LOGS , AUDIT_LOGS , depending on the types of logs you want to publish.

Returns:



566
567
568
 
# File 'open_search_service/cfn_domain.rb', line 566

def log_publishing_options()
  jsii_get_property("logPublishingOptions")
end

#log_publishing_options=(value) ⇒ Object 



570
571
572
573
 
# File 'open_search_service/cfn_domain.rb', line 570

def log_publishing_options=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfb3BlbnNlYXJjaHNlcnZpY2UuQ2ZuRG9tYWluLkxvZ1B1Ymxpc2hpbmdPcHRpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoibWFwIn19XX19")), "logPublishingOptions") unless value.nil?
  jsii_set_property("logPublishingOptions", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


171
172
173
 
# File 'open_search_service/cfn_domain.rb', line 171

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


154
155
156
 
# File 'open_search_service/cfn_domain.rb', line 154

def node()
  jsii_get_property("node")
end

#node_to_node_encryption_options ⇒ AWSCDK::IResolvable, ...

Specifies whether node-to-node encryption is enabled.

Returns:



578
579
580
 
# File 'open_search_service/cfn_domain.rb', line 578

def node_to_node_encryption_options()
  jsii_get_property("nodeToNodeEncryptionOptions")
end

#node_to_node_encryption_options=(value) ⇒ Object 



582
583
584
585
586
 
# File 'open_search_service/cfn_domain.rb', line 582

def node_to_node_encryption_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::OpenSearchService::CfnDomain::NodeToNodeEncryptionOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmljZS5DZm5Eb21haW4uTm9kZVRvTm9kZUVuY3J5cHRpb25PcHRpb25zUHJvcGVydHkifV19fQ==")), "nodeToNodeEncryptionOptions") unless value.nil?
  jsii_set_property("nodeToNodeEncryptionOptions", value)
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



890
891
892
 
# File 'open_search_service/cfn_domain.rb', line 890

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



897
898
899
 
# File 'open_search_service/cfn_domain.rb', line 897

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#off_peak_window_options ⇒ AWSCDK::IResolvable, ...

Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.

Returns:



591
592
593
 
# File 'open_search_service/cfn_domain.rb', line 591

def off_peak_window_options()
  jsii_get_property("offPeakWindowOptions")
end

#off_peak_window_options=(value) ⇒ Object 



595
596
597
598
599
 
# File 'open_search_service/cfn_domain.rb', line 595

def off_peak_window_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::OpenSearchService::CfnDomain::OffPeakWindowOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmljZS5DZm5Eb21haW4uT2ZmUGVha1dpbmRvd09wdGlvbnNQcm9wZXJ0eSJ9XX19")), "offPeakWindowOptions") unless value.nil?
  jsii_set_property("offPeakWindowOptions", value)
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



690
691
692
693
 
# File 'open_search_service/cfn_domain.rb', line 690

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


190
191
192
 
# File 'open_search_service/cfn_domain.rb', line 190

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



908
909
910
911
 
# File 'open_search_service/cfn_domain.rb', line 908

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


915
916
917
918
 
# File 'open_search_service/cfn_domain.rb', line 915

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



925
926
927
928
929
 
# File 'open_search_service/cfn_domain.rb', line 925

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



934
935
936
 
# File 'open_search_service/cfn_domain.rb', line 934

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#skip_shard_migration_wait ⇒ Boolean, ...

Returns:



602
603
604
 
# File 'open_search_service/cfn_domain.rb', line 602

def skip_shard_migration_wait()
  jsii_get_property("skipShardMigrationWait")
end

#skip_shard_migration_wait=(value) ⇒ Object 



606
607
608
609
 
# File 'open_search_service/cfn_domain.rb', line 606

def skip_shard_migration_wait=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "skipShardMigrationWait") unless value.nil?
  jsii_set_property("skipShardMigrationWait", value)
end

#snapshot_options ⇒ AWSCDK::IResolvable, ...

DEPRECATED .

Returns:



614
615
616
 
# File 'open_search_service/cfn_domain.rb', line 614

def snapshot_options()
  jsii_get_property("snapshotOptions")
end

#snapshot_options=(value) ⇒ Object 



618
619
620
621
622
 
# File 'open_search_service/cfn_domain.rb', line 618

def snapshot_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::OpenSearchService::CfnDomain::SnapshotOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmljZS5DZm5Eb21haW4uU25hcHNob3RPcHRpb25zUHJvcGVydHkifV19fQ==")), "snapshotOptions") unless value.nil?
  jsii_set_property("snapshotOptions", value)
end

#software_update_options ⇒ AWSCDK::IResolvable, ...

Service software update options for the domain.

Returns:



627
628
629
 
# File 'open_search_service/cfn_domain.rb', line 627

def software_update_options()
  jsii_get_property("softwareUpdateOptions")
end

#software_update_options=(value) ⇒ Object 



631
632
633
634
635
 
# File 'open_search_service/cfn_domain.rb', line 631

def software_update_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::OpenSearchService::CfnDomain::SoftwareUpdateOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmljZS5DZm5Eb21haW4uU29mdHdhcmVVcGRhdGVPcHRpb25zUHJvcGVydHkifV19fQ==")), "softwareUpdateOptions") unless value.nil?
  jsii_set_property("softwareUpdateOptions", value)
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



180
181
182
 
# File 'open_search_service/cfn_domain.rb', line 180

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



363
364
365
 
# File 'open_search_service/cfn_domain.rb', line 363

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain.

Returns:



640
641
642
 
# File 'open_search_service/cfn_domain.rb', line 640

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



644
645
646
647
648
 
# File 'open_search_service/cfn_domain.rb', line 644

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



666
667
668
 
# File 'open_search_service/cfn_domain.rb', line 666

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


227
228
229
 
# File 'open_search_service/cfn_domain.rb', line 227

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


237
238
239
 
# File 'open_search_service/cfn_domain.rb', line 237

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


940
941
942
943
 
# File 'open_search_service/cfn_domain.rb', line 940

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#vpc_options ⇒ AWSCDK::IResolvable, ...

The virtual private cloud (VPC) configuration for the OpenSearch Service domain.

Returns:



653
654
655
 
# File 'open_search_service/cfn_domain.rb', line 653

def vpc_options()
  jsii_get_property("vpcOptions")
end

#vpc_options=(value) ⇒ Object 



657
658
659
660
661
 
# File 'open_search_service/cfn_domain.rb', line 657

def vpc_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::OpenSearchService::CfnDomain::VPCOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmljZS5DZm5Eb21haW4uVlBDT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "vpcOptions") unless value.nil?
  jsii_set_property("vpcOptions", value)
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) 


679
680
681
682
683
684
 
# File 'open_search_service/cfn_domain.rb', line 679

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