Class: AWSCDK::Elasticsearch::CfnDomain
- Inherits:
-
CfnResource
- Object
- CfnResource
- AWSCDK::Elasticsearch::CfnDomain
- Includes:
- IInspectable, ITaggable, Interfaces::AWSElasticsearch::IDomainRef
- Defined in:
- elasticsearch/cfn_domain.rb
Overview
The AWS::Elasticsearch::Domain resource creates an Amazon OpenSearch Service domain.
The
AWS::Elasticsearch::Domainresource is being replaced by the AWS::OpenSearchService::Domain resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and legacy Elasticsearch. For instructions to upgrade domains defined within CloudFormation from Elasticsearch to OpenSearch, see Remarks .
Class Method Summary collapse
- .arn_for_domain(resource) ⇒ String
-
.CFN_RESOURCE_TYPE_NAME ⇒ String
The CloudFormation resource type name for this resource class.
-
.from_domain_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSElasticsearch::IDomainRef
Creates a new IDomainRef from an ARN.
-
.from_domain_name(scope, id, domain_name) ⇒ AWSCDK::Interfaces::AWSElasticsearch::IDomainRef
Creates a new IDomainRef from a domainName.
-
.is_cfn_domain(x) ⇒ Boolean
Checks whether the given object is a CfnDomain.
- .jsii_overridable_methods ⇒ Object
Instance Method Summary collapse
-
#access_policies ⇒ Object
An AWS Identity and Access Management ( IAM ) policy document that specifies who can access the OpenSearch Service domain and their permissions.
- #access_policies=(value) ⇒ Object
-
#add_deletion_override(path) ⇒ void
Syntactic sugar for
addOverride(path, undefined). -
#add_dependency(target) ⇒ void
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
-
#add_depends_on(target) ⇒ void
deprecated
Deprecated.
use addDependency
-
#add_metadata(key, value) ⇒ void
Add a value to the CloudFormation Resource Metadata.
-
#add_override(path, value) ⇒ void
Adds an override to the synthesized CloudFormation resource.
-
#add_property_deletion_override(property_path) ⇒ void
Adds an override that deletes the value of a property from the resource definition.
-
#add_property_override(property_path, value) ⇒ void
Adds an override to a resource property.
-
#advanced_options ⇒ AWSCDK::IResolvable, ...
Additional options to specify for the OpenSearch Service domain.
- #advanced_options=(value) ⇒ Object
-
#advanced_security_options ⇒ AWSCDK::IResolvable, ...
Specifies options for fine-grained access control.
- #advanced_security_options=(value) ⇒ Object
-
#apply_cross_stack_reference_strength(strength) ⇒ void
Sets the cross-stack reference strength for this resource.
-
#apply_removal_policy(policy = nil, options = nil) ⇒ void
Sets the deletion policy of the resource based on the removal policy specified.
-
#attr_arn ⇒ String
The Amazon Resource Name (ARN) of the domain, such as
arn:aws:es:us-west-2:123456789012:domain/mystack-elasti-1ab2cdefghij. -
#attr_domain_endpoint ⇒ String
The domain-specific endpoint that's used for requests to the OpenSearch APIs, such as
search-mystack-elasti-1ab2cdefghij-ab1c2deckoyb3hofw7wpqa3cm.us-west-1.es.amazonaws.com. - #attr_id ⇒ String
-
#cfn_options ⇒ AWSCDK::ICfnResourceOptions
Options for this resource, such as condition, update policy etc.
- #cfn_properties ⇒ Hash{String => Object}
- #cfn_property_name(cdk_property_name) ⇒ String?
- #cfn_property_names ⇒ Hash{String => String}
-
#cfn_resource_type ⇒ String
AWS resource type.
-
#cognito_options ⇒ AWSCDK::IResolvable, ...
Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
- #cognito_options=(value) ⇒ Object
- #creation_stack ⇒ Array<String>
- #domain_arn ⇒ String?
- #domain_arn=(value) ⇒ Object
-
#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.
- #domain_endpoint_options=(value) ⇒ Object
-
#domain_name ⇒ String?
A name for the OpenSearch Service domain.
- #domain_name=(value) ⇒ Object
-
#domain_ref ⇒ AWSCDK::Interfaces::AWSElasticsearch::DomainReference
A reference to a Domain resource.
-
#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.
- #ebs_options=(value) ⇒ Object
-
#elasticsearch_cluster_config ⇒ AWSCDK::IResolvable, ...
ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain.
- #elasticsearch_cluster_config=(value) ⇒ Object
-
#elasticsearch_version ⇒ String?
The version of Elasticsearch to use, such as 2.3.
- #elasticsearch_version=(value) ⇒ Object
-
#encryption_at_rest_options ⇒ AWSCDK::IResolvable, ...
Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.
- #encryption_at_rest_options=(value) ⇒ Object
- #env ⇒ AWSCDK::Interfaces::ResourceEnvironment
-
#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference
Returns a token for an runtime attribute of this resource.
-
#get_metadata(key) ⇒ Object
Retrieve a value value from the CloudFormation Resource Metadata.
-
#initialize(scope, id, props = nil) ⇒ CfnDomain
constructor
Create a new
AWS::Elasticsearch::Domain. -
#inspect(inspector) ⇒ void
Examines the CloudFormation resource and discloses attributes.
-
#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. - #log_publishing_options=(value) ⇒ Object
-
#logical_id ⇒ String
The logical ID for this CloudFormation stack element.
-
#node ⇒ Constructs::Node
The tree node.
-
#node_to_node_encryption_options ⇒ AWSCDK::IResolvable, ...
Specifies whether node-to-node encryption is enabled.
- #node_to_node_encryption_options=(value) ⇒ Object
-
#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>
Retrieves an array of resources this resource depends on.
-
#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>
Get a shallow copy of dependencies between this resource and other resources in the same stack.
-
#override_logical_id(new_logical_id) ⇒ void
Overrides the auto-generated logical ID with a specific ID.
-
#ref ⇒ String
Return a string that will be resolved to a CloudFormation
{ Ref }for this element. -
#remove_dependency(target) ⇒ void
Indicates that this resource no longer depends on another resource.
- #render_properties(props) ⇒ Hash{String => Object}
-
#replace_dependency(target, new_target) ⇒ void
Replaces one dependency with another.
-
#should_synthesize ⇒ Boolean
Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
-
#snapshot_options ⇒ AWSCDK::IResolvable, ...
DEPRECATED .
- #snapshot_options=(value) ⇒ Object
-
#stack ⇒ AWSCDK::Stack
The stack in which this element is defined.
-
#tags ⇒ AWSCDK::TagManager
Tag Manager which manages the tags for this resource.
-
#tags_raw ⇒ Array<AWSCDK::CfnTag>?
An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain.
- #tags_raw=(value) ⇒ Object
-
#to_string ⇒ String
Returns a string representation of this construct.
-
#updated_properites ⇒ Hash{String => Object}
deprecated
Deprecated.
use
updatedPropertiesReturn properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource. -
#updated_properties ⇒ Hash{String => Object}
Return properties modified after initiation.
- #validate_properties(_properties) ⇒ void
-
#vpc_options ⇒ AWSCDK::IResolvable, ...
The virtual private cloud (VPC) configuration for the OpenSearch Service domain.
- #vpc_options=(value) ⇒ Object
-
#with(*mixins) ⇒ Constructs::IConstruct
Applies one or more mixins to this construct.
Constructor Details
#initialize(scope, id, props = nil) ⇒ CfnDomain
Create a new AWS::Elasticsearch::Domain.
20 21 22 23 24 25 26 |
# File 'elasticsearch/cfn_domain.rb', line 20 def initialize(scope, id, props = nil) props = props.is_a?(Hash) ? ::AWSCDK::Elasticsearch::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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY3NlYXJjaC5DZm5Eb21haW5Qcm9wcyJ9")), "props") unless props.nil? Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props) end |
Class Method Details
.arn_for_domain(resource) ⇒ String
91 92 93 94 |
# File 'elasticsearch/cfn_domain.rb', line 91 def self.arn_for_domain(resource) Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lbGFzdGljc2VhcmNoLklEb21haW5SZWYifQ==")), "resource") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_elasticsearch.CfnDomain", "arnForDomain", [resource]) end |
.CFN_RESOURCE_TYPE_NAME ⇒ String
The CloudFormation resource type name for this resource class.
224 225 226 |
# File 'elasticsearch/cfn_domain.rb', line 224 def self.CFN_RESOURCE_TYPE_NAME() Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_elasticsearch.CfnDomain", "CFN_RESOURCE_TYPE_NAME") end |
.from_domain_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSElasticsearch::IDomainRef
Creates a new IDomainRef from an ARN.
102 103 104 105 106 107 |
# File 'elasticsearch/cfn_domain.rb', line 102 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_elasticsearch.CfnDomain", "fromDomainArn", [scope, id, arn]) end |
.from_domain_name(scope, id, domain_name) ⇒ AWSCDK::Interfaces::AWSElasticsearch::IDomainRef
Creates a new IDomainRef from a domainName.
115 116 117 118 119 120 |
# File 'elasticsearch/cfn_domain.rb', line 115 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_elasticsearch.CfnDomain", "fromDomainName", [scope, id, domain_name]) end |
.is_cfn_domain(x) ⇒ Boolean
Checks whether the given object is a CfnDomain.
126 127 128 129 |
# File 'elasticsearch/cfn_domain.rb', line 126 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_elasticsearch.CfnDomain", "isCfnDomain", [x]) end |
.jsii_overridable_methods ⇒ Object
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 |
# File 'elasticsearch/cfn_domain.rb', line 28 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_arn => { kind: :property, name: "attrArn", is_optional: false }, :attr_domain_endpoint => { kind: :property, name: "attrDomainEndpoint", is_optional: false }, :attr_id => { kind: :property, name: "attrId", 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 }, :cognito_options => { kind: :property, name: "cognitoOptions", 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 }, :elasticsearch_cluster_config => { kind: :property, name: "elasticsearchClusterConfig", is_optional: true }, :elasticsearch_version => { kind: :property, name: "elasticsearchVersion", is_optional: true }, :encryption_at_rest_options => { kind: :property, name: "encryptionAtRestOptions", 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 }, :snapshot_options => { kind: :property, name: "snapshotOptions", 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.
266 267 268 |
# File 'elasticsearch/cfn_domain.rb', line 266 def access_policies() jsii_get_property("accessPolicies") end |
#access_policies=(value) ⇒ Object
270 271 272 273 |
# File 'elasticsearch/cfn_domain.rb', line 270 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).
499 500 501 502 |
# File 'elasticsearch/cfn_domain.rb', line 499 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.
511 512 513 514 |
# File 'elasticsearch/cfn_domain.rb', line 511 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
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.
521 522 523 524 |
# File 'elasticsearch/cfn_domain.rb', line 521 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.
532 533 534 535 536 |
# File 'elasticsearch/cfn_domain.rb', line 532 def (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.
589 590 591 592 593 |
# File 'elasticsearch/cfn_domain.rb', line 589 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.
599 600 601 602 |
# File 'elasticsearch/cfn_domain.rb', line 599 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).
611 612 613 614 615 |
# File 'elasticsearch/cfn_domain.rb', line 611 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.
278 279 280 |
# File 'elasticsearch/cfn_domain.rb', line 278 def () jsii_get_property("advancedOptions") end |
#advanced_options=(value) ⇒ Object
282 283 284 285 |
# File 'elasticsearch/cfn_domain.rb', line 282 def (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.
290 291 292 |
# File 'elasticsearch/cfn_domain.rb', line 290 def () jsii_get_property("advancedSecurityOptions") end |
#advanced_security_options=(value) ⇒ Object
294 295 296 297 298 |
# File 'elasticsearch/cfn_domain.rb', line 294 def (value) value = value.is_a?(Hash) ? ::AWSCDK::Elasticsearch::CfnDomain::AdvancedSecurityOptionsInputProperty.new(**value.transform_keys(&:to_sym)) : value Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lbGFzdGljc2VhcmNoLkNmbkRvbWFpbi5BZHZhbmNlZFNlY3VyaXR5T3B0aW9uc0lucHV0UHJvcGVydHkifV19fQ==")), "advancedSecurityOptions") unless value.nil? jsii_set_property("advancedSecurityOptions", 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.
624 625 626 627 |
# File 'elasticsearch/cfn_domain.rb', line 624 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:
646 647 648 649 650 651 |
# File 'elasticsearch/cfn_domain.rb', line 646 def apply_removal_policy(policy = nil, = nil) Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil? = .is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**.transform_keys(&:to_sym)) : Jsii::Type.check_type(, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless .nil? jsii_call_method("applyRemovalPolicy", [policy, ]) end |
#attr_arn ⇒ String
The Amazon Resource Name (ARN) of the domain, such as arn:aws:es:us-west-2:123456789012:domain/mystack-elasti-1ab2cdefghij .
This returned value is the same as the one returned by AWS::Elasticsearch::Domain.DomainArn .
233 234 235 |
# File 'elasticsearch/cfn_domain.rb', line 233 def attr_arn() jsii_get_property("attrArn") end |
#attr_domain_endpoint ⇒ String
The domain-specific endpoint that's used for requests to the OpenSearch APIs, such as search-mystack-elasti-1ab2cdefghij-ab1c2deckoyb3hofw7wpqa3cm.us-west-1.es.amazonaws.com .
240 241 242 |
# File 'elasticsearch/cfn_domain.rb', line 240 def attr_domain_endpoint() jsii_get_property("attrDomainEndpoint") end |
#attr_id ⇒ String
245 246 247 |
# File 'elasticsearch/cfn_domain.rb', line 245 def attr_id() jsii_get_property("attrId") end |
#cfn_options ⇒ AWSCDK::ICfnResourceOptions
Options for this resource, such as condition, update policy etc.
177 178 179 |
# File 'elasticsearch/cfn_domain.rb', line 177 def () jsii_get_property("cfnOptions") end |
#cfn_properties ⇒ Hash{String => Object}
182 183 184 |
# File 'elasticsearch/cfn_domain.rb', line 182 def cfn_properties() jsii_get_property("cfnProperties") end |
#cfn_property_name(cdk_property_name) ⇒ String?
655 656 657 658 |
# File 'elasticsearch/cfn_domain.rb', line 655 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}
187 188 189 |
# File 'elasticsearch/cfn_domain.rb', line 187 def cfn_property_names() jsii_get_property("cfnPropertyNames") end |
#cfn_resource_type ⇒ String
AWS resource type.
194 195 196 |
# File 'elasticsearch/cfn_domain.rb', line 194 def cfn_resource_type() jsii_get_property("cfnResourceType") end |
#cognito_options ⇒ AWSCDK::IResolvable, ...
Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
303 304 305 |
# File 'elasticsearch/cfn_domain.rb', line 303 def () jsii_get_property("cognitoOptions") end |
#cognito_options=(value) ⇒ Object
307 308 309 310 311 |
# File 'elasticsearch/cfn_domain.rb', line 307 def (value) value = value.is_a?(Hash) ? ::AWSCDK::Elasticsearch::CfnDomain::CognitoOptionsProperty.new(**value.transform_keys(&:to_sym)) : value Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lbGFzdGljc2VhcmNoLkNmbkRvbWFpbi5Db2duaXRvT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "cognitoOptions") unless value.nil? jsii_set_property("cognitoOptions", value) end |
#creation_stack ⇒ Array<String>
139 140 141 |
# File 'elasticsearch/cfn_domain.rb', line 139 def creation_stack() jsii_get_property("creationStack") end |
#domain_arn ⇒ String?
314 315 316 |
# File 'elasticsearch/cfn_domain.rb', line 314 def domain_arn() jsii_get_property("domainArn") end |
#domain_arn=(value) ⇒ Object
318 319 320 321 |
# File 'elasticsearch/cfn_domain.rb', line 318 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.
326 327 328 |
# File 'elasticsearch/cfn_domain.rb', line 326 def () jsii_get_property("domainEndpointOptions") end |
#domain_endpoint_options=(value) ⇒ Object
330 331 332 333 334 |
# File 'elasticsearch/cfn_domain.rb', line 330 def (value) value = value.is_a?(Hash) ? ::AWSCDK::Elasticsearch::CfnDomain::DomainEndpointOptionsProperty.new(**value.transform_keys(&:to_sym)) : value Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lbGFzdGljc2VhcmNoLkNmbkRvbWFpbi5Eb21haW5FbmRwb2ludE9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "domainEndpointOptions") unless value.nil? jsii_set_property("domainEndpointOptions", value) end |
#domain_name ⇒ String?
A name for the OpenSearch Service domain.
339 340 341 |
# File 'elasticsearch/cfn_domain.rb', line 339 def domain_name() jsii_get_property("domainName") end |
#domain_name=(value) ⇒ Object
343 344 345 346 |
# File 'elasticsearch/cfn_domain.rb', line 343 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::AWSElasticsearch::DomainReference
A reference to a Domain resource.
252 253 254 |
# File 'elasticsearch/cfn_domain.rb', line 252 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.
351 352 353 |
# File 'elasticsearch/cfn_domain.rb', line 351 def () jsii_get_property("ebsOptions") end |
#ebs_options=(value) ⇒ Object
355 356 357 358 359 |
# File 'elasticsearch/cfn_domain.rb', line 355 def (value) value = value.is_a?(Hash) ? ::AWSCDK::Elasticsearch::CfnDomain::EBSOptionsProperty.new(**value.transform_keys(&:to_sym)) : value Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lbGFzdGljc2VhcmNoLkNmbkRvbWFpbi5FQlNPcHRpb25zUHJvcGVydHkifV19fQ==")), "ebsOptions") unless value.nil? jsii_set_property("ebsOptions", value) end |
#elasticsearch_cluster_config ⇒ AWSCDK::IResolvable, ...
ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain.
364 365 366 |
# File 'elasticsearch/cfn_domain.rb', line 364 def elasticsearch_cluster_config() jsii_get_property("elasticsearchClusterConfig") end |
#elasticsearch_cluster_config=(value) ⇒ Object
368 369 370 371 372 |
# File 'elasticsearch/cfn_domain.rb', line 368 def elasticsearch_cluster_config=(value) value = value.is_a?(Hash) ? ::AWSCDK::Elasticsearch::CfnDomain::ElasticsearchClusterConfigProperty.new(**value.transform_keys(&:to_sym)) : value Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lbGFzdGljc2VhcmNoLkNmbkRvbWFpbi5FbGFzdGljc2VhcmNoQ2x1c3RlckNvbmZpZ1Byb3BlcnR5In1dfX0=")), "elasticsearchClusterConfig") unless value.nil? jsii_set_property("elasticsearchClusterConfig", value) end |
#elasticsearch_version ⇒ String?
The version of Elasticsearch to use, such as 2.3. If not specified, 1.5 is used as the default. For information about the versions that OpenSearch Service supports, see Supported versions of OpenSearch and Elasticsearch in the Amazon OpenSearch Service Developer Guide .
377 378 379 |
# File 'elasticsearch/cfn_domain.rb', line 377 def elasticsearch_version() jsii_get_property("elasticsearchVersion") end |
#elasticsearch_version=(value) ⇒ Object
381 382 383 384 |
# File 'elasticsearch/cfn_domain.rb', line 381 def elasticsearch_version=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "elasticsearchVersion") unless value.nil? jsii_set_property("elasticsearchVersion", value) end |
#encryption_at_rest_options ⇒ AWSCDK::IResolvable, ...
Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.
389 390 391 |
# File 'elasticsearch/cfn_domain.rb', line 389 def () jsii_get_property("encryptionAtRestOptions") end |
#encryption_at_rest_options=(value) ⇒ Object
393 394 395 396 397 |
# File 'elasticsearch/cfn_domain.rb', line 393 def (value) value = value.is_a?(Hash) ? ::AWSCDK::Elasticsearch::CfnDomain::EncryptionAtRestOptionsProperty.new(**value.transform_keys(&:to_sym)) : value Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lbGFzdGljc2VhcmNoLkNmbkRvbWFpbi5FbmNyeXB0aW9uQXRSZXN0T3B0aW9uc1Byb3BlcnR5In1dfX0=")), "encryptionAtRestOptions") unless value.nil? jsii_set_property("encryptionAtRestOptions", value) end |
#env ⇒ AWSCDK::Interfaces::ResourceEnvironment
199 200 201 |
# File 'elasticsearch/cfn_domain.rb', line 199 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.
668 669 670 671 672 |
# File 'elasticsearch/cfn_domain.rb', line 668 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.
679 680 681 682 |
# File 'elasticsearch/cfn_domain.rb', line 679 def (key) Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key") jsii_call_method("getMetadata", [key]) end |
#inspect(inspector) ⇒ void
This method returns an undefined value.
Examines the CloudFormation resource and discloses attributes.
749 750 751 752 |
# File 'elasticsearch/cfn_domain.rb', line 749 def inspect(inspector) Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector") jsii_call_method("inspect", [inspector]) 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.
402 403 404 |
# File 'elasticsearch/cfn_domain.rb', line 402 def () jsii_get_property("logPublishingOptions") end |
#log_publishing_options=(value) ⇒ Object
406 407 408 409 |
# File 'elasticsearch/cfn_domain.rb', line 406 def (value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY3NlYXJjaC5DZm5Eb21haW4uTG9nUHVibGlzaGluZ09wdGlvblByb3BlcnR5In1dfX0sImtpbmQiOiJtYXAifX1dfX0=")), "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).
151 152 153 |
# File 'elasticsearch/cfn_domain.rb', line 151 def logical_id() jsii_get_property("logicalId") end |
#node ⇒ Constructs::Node
The tree node.
134 135 136 |
# File 'elasticsearch/cfn_domain.rb', line 134 def node() jsii_get_property("node") end |
#node_to_node_encryption_options ⇒ AWSCDK::IResolvable, ...
Specifies whether node-to-node encryption is enabled.
414 415 416 |
# File 'elasticsearch/cfn_domain.rb', line 414 def () jsii_get_property("nodeToNodeEncryptionOptions") end |
#node_to_node_encryption_options=(value) ⇒ Object
418 419 420 421 422 |
# File 'elasticsearch/cfn_domain.rb', line 418 def (value) value = value.is_a?(Hash) ? ::AWSCDK::Elasticsearch::CfnDomain::NodeToNodeEncryptionOptionsProperty.new(**value.transform_keys(&:to_sym)) : value Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lbGFzdGljc2VhcmNoLkNmbkRvbWFpbi5Ob2RlVG9Ob2RlRW5jcnlwdGlvbk9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "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.
690 691 692 |
# File 'elasticsearch/cfn_domain.rb', line 690 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.
697 698 699 |
# File 'elasticsearch/cfn_domain.rb', line 697 def obtain_resource_dependencies() jsii_call_method("obtainResourceDependencies", []) end |
#override_logical_id(new_logical_id) ⇒ void
This method returns an undefined value.
Overrides the auto-generated logical ID with a specific ID.
490 491 492 493 |
# File 'elasticsearch/cfn_domain.rb', line 490 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 }).
170 171 172 |
# File 'elasticsearch/cfn_domain.rb', line 170 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.
708 709 710 711 |
# File 'elasticsearch/cfn_domain.rb', line 708 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}
715 716 717 718 |
# File 'elasticsearch/cfn_domain.rb', line 715 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.
725 726 727 728 729 |
# File 'elasticsearch/cfn_domain.rb', line 725 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.
734 735 736 |
# File 'elasticsearch/cfn_domain.rb', line 734 def should_synthesize() jsii_call_method("shouldSynthesize", []) end |
#snapshot_options ⇒ AWSCDK::IResolvable, ...
DEPRECATED .
427 428 429 |
# File 'elasticsearch/cfn_domain.rb', line 427 def () jsii_get_property("snapshotOptions") end |
#snapshot_options=(value) ⇒ Object
431 432 433 434 435 |
# File 'elasticsearch/cfn_domain.rb', line 431 def (value) value = value.is_a?(Hash) ? ::AWSCDK::Elasticsearch::CfnDomain::SnapshotOptionsProperty.new(**value.transform_keys(&:to_sym)) : value Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lbGFzdGljc2VhcmNoLkNmbkRvbWFpbi5TbmFwc2hvdE9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "snapshotOptions") unless value.nil? jsii_set_property("snapshotOptions", value) end |
#stack ⇒ AWSCDK::Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
160 161 162 |
# File 'elasticsearch/cfn_domain.rb', line 160 def stack() jsii_get_property("stack") end |
#tags ⇒ AWSCDK::TagManager
Tag Manager which manages the tags for this resource.
259 260 261 |
# File 'elasticsearch/cfn_domain.rb', line 259 def () 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.
440 441 442 |
# File 'elasticsearch/cfn_domain.rb', line 440 def () jsii_get_property("tagsRaw") end |
#tags_raw=(value) ⇒ Object
444 445 446 447 448 |
# File 'elasticsearch/cfn_domain.rb', line 444 def (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.
466 467 468 |
# File 'elasticsearch/cfn_domain.rb', line 466 def to_string() jsii_call_method("toString", []) end |
#updated_properites ⇒ Hash{String => Object}
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.
207 208 209 |
# File 'elasticsearch/cfn_domain.rb', line 207 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.
217 218 219 |
# File 'elasticsearch/cfn_domain.rb', line 217 def updated_properties() jsii_get_property("updatedProperties") end |
#validate_properties(_properties) ⇒ void
This method returns an undefined value.
740 741 742 743 |
# File 'elasticsearch/cfn_domain.rb', line 740 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.
453 454 455 |
# File 'elasticsearch/cfn_domain.rb', line 453 def () jsii_get_property("vpcOptions") end |
#vpc_options=(value) ⇒ Object
457 458 459 460 461 |
# File 'elasticsearch/cfn_domain.rb', line 457 def (value) value = value.is_a?(Hash) ? ::AWSCDK::Elasticsearch::CfnDomain::VPCOptionsProperty.new(**value.transform_keys(&:to_sym)) : value Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lbGFzdGljc2VhcmNoLkNmbkRvbWFpbi5WUENPcHRpb25zUHJvcGVydHkifV19fQ==")), "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.
479 480 481 482 483 484 |
# File 'elasticsearch/cfn_domain.rb', line 479 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 |