Class: AWSCDK::OpenSearchServerless::CfnCollection

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSOpensearchserverless::ICollectionRef
Defined in:
open_search_serverless/cfn_collection.rb

Overview

Specifies an OpenSearch Serverless collection.

For more information, see Creating and managing Amazon OpenSearch Serverless collections in the Amazon OpenSearch Service Developer Guide .

You must create a matching encryption policy in order for a collection to be created successfully. You can specify the policy resource within the same CloudFormation template as the collection resource if you use the DependsOn attribute. See Examples for a sample template. Otherwise the encryption policy must already exist before you create the collection.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnCollection

Create a new AWS::OpenSearchServerless::Collection.

Parameters:



22
23
24
25
26
27
28
 
# File 'open_search_serverless/cfn_collection.rb', line 22

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::OpenSearchServerless::CfnCollectionProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfb3BlbnNlYXJjaHNlcnZlcmxlc3MuQ2ZuQ29sbGVjdGlvblByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_collection(resource) ⇒ String

Parameters:

Returns:

  • (String) 


89
90
91
92
 
# File 'open_search_serverless/cfn_collection.rb', line 89

def self.arn_for_collection(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19vcGVuc2VhcmNoc2VydmVybGVzcy5JQ29sbGVjdGlvblJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_opensearchserverless.CfnCollection", "arnForCollection", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


222
223
224
 
# File 'open_search_serverless/cfn_collection.rb', line 222

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

.from_collection_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSOpensearchserverless::ICollectionRef

Creates a new ICollectionRef from an ARN.

Parameters:

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

Returns:



100
101
102
103
104
105
 
# File 'open_search_serverless/cfn_collection.rb', line 100

def self.from_collection_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_opensearchserverless.CfnCollection", "fromCollectionArn", [scope, id, arn])
end

.from_collection_id(scope, id, collection_id) ⇒ AWSCDK::Interfaces::AWSOpensearchserverless::ICollectionRef

Creates a new ICollectionRef from a collectionId.

Parameters:

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

Returns:



113
114
115
116
117
118
 
# File 'open_search_serverless/cfn_collection.rb', line 113

def self.from_collection_id(scope, id, collection_id)
  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(collection_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "collectionId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_opensearchserverless.CfnCollection", "fromCollectionId", [scope, id, collection_id])
end

.is_cfn_collection(x) ⇒ Boolean

Checks whether the given object is a CfnCollection.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


124
125
126
127
 
# File 'open_search_serverless/cfn_collection.rb', line 124

def self.is_cfn_collection(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_opensearchserverless.CfnCollection", "isCfnCollection", [x])
end

.jsii_overridable_methods ⇒ Object 



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
 
# File 'open_search_serverless/cfn_collection.rb', line 30

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_collection_endpoint => { kind: :property, name: "attrCollectionEndpoint", is_optional: false },
    :attr_dashboard_endpoint => { kind: :property, name: "attrDashboardEndpoint", is_optional: false },
    :attr_fips_endpoints => { kind: :property, name: "attrFipsEndpoints", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_kms_key_arn => { kind: :property, name: "attrKmsKeyArn", is_optional: false },
    :collection_ref => { kind: :property, name: "collectionRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :collection_group_name => { kind: :property, name: "collectionGroupName", is_optional: true },
    :deletion_protection => { kind: :property, name: "deletionProtection", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :encryption_config => { kind: :property, name: "encryptionConfig", is_optional: true },
    :standby_replicas => { kind: :property, name: "standbyReplicas", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :type => { kind: :property, name: "type", is_optional: true },
    :vector_options => { kind: :property, name: "vectorOptions", 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

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



435
436
437
438
 
# File 'open_search_serverless/cfn_collection.rb', line 435

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:



447
448
449
450
 
# File 'open_search_serverless/cfn_collection.rb', line 447

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:



457
458
459
460
 
# File 'open_search_serverless/cfn_collection.rb', line 457

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:



468
469
470
471
472
 
# File 'open_search_serverless/cfn_collection.rb', line 468

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.


525
526
527
528
529
 
# File 'open_search_serverless/cfn_collection.rb', line 525

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.



535
536
537
538
 
# File 'open_search_serverless/cfn_collection.rb', line 535

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.



547
548
549
550
551
 
# File 'open_search_serverless/cfn_collection.rb', line 547

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

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



560
561
562
563
 
# File 'open_search_serverless/cfn_collection.rb', line 560

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:



582
583
584
585
586
587
 
# File 'open_search_serverless/cfn_collection.rb', line 582

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_arn ⇒ String

The Amazon Resource Name (ARN) of the collection.

For example, arn:aws:aoss:us-east-1:123456789012:collection/07tjusf2h91cunochc .

Returns:

  • (String) 


231
232
233
 
# File 'open_search_serverless/cfn_collection.rb', line 231

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_collection_endpoint ⇒ String

Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.

For example, https://07tjusf2h91cunochc.us-east-1.aoss.amazonaws.com .

Returns:

  • (String) 


240
241
242
 
# File 'open_search_serverless/cfn_collection.rb', line 240

def attr_collection_endpoint()
  jsii_get_property("attrCollectionEndpoint")
end

#attr_dashboard_endpoint ⇒ String

The collection-specific endpoint used to access OpenSearch Dashboards.

For example, https://07tjusf2h91cunochc.us-east-1.aoss.amazonaws.com/_dashboards .

Returns:

  • (String) 


249
250
251
 
# File 'open_search_serverless/cfn_collection.rb', line 249

def attr_dashboard_endpoint()
  jsii_get_property("attrDashboardEndpoint")
end

#attr_fips_endpoints ⇒ AWSCDK::IResolvable

Returns:



254
255
256
 
# File 'open_search_serverless/cfn_collection.rb', line 254

def attr_fips_endpoints()
  jsii_get_property("attrFipsEndpoints")
end

#attr_id ⇒ String

A unique identifier for the collection.

For example, 07tjusf2h91cunochc .

Returns:

  • (String) 


263
264
265
 
# File 'open_search_serverless/cfn_collection.rb', line 263

def attr_id()
  jsii_get_property("attrId")
end

#attr_kms_key_arn ⇒ String

The ARN of the AWS KMS key used to encrypt the collection.

Returns:

  • (String) 


270
271
272
 
# File 'open_search_serverless/cfn_collection.rb', line 270

def attr_kms_key_arn()
  jsii_get_property("attrKmsKeyArn")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



175
176
177
 
# File 'open_search_serverless/cfn_collection.rb', line 175

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


180
181
182
 
# File 'open_search_serverless/cfn_collection.rb', line 180

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


591
592
593
594
 
# File 'open_search_serverless/cfn_collection.rb', line 591

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


185
186
187
 
# File 'open_search_serverless/cfn_collection.rb', line 185

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


192
193
194
 
# File 'open_search_serverless/cfn_collection.rb', line 192

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#collection_group_name ⇒ String?

The name of the collection group to associate with the collection.

Returns:

  • (String, nil) 


303
304
305
 
# File 'open_search_serverless/cfn_collection.rb', line 303

def collection_group_name()
  jsii_get_property("collectionGroupName")
end

#collection_group_name=(value) ⇒ Object 



307
308
309
310
 
# File 'open_search_serverless/cfn_collection.rb', line 307

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

#collection_ref ⇒ AWSCDK::Interfaces::AWSOpensearchserverless::CollectionReference

A reference to a Collection resource.

Returns:



277
278
279
 
# File 'open_search_serverless/cfn_collection.rb', line 277

def collection_ref()
  jsii_get_property("collectionRef")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


137
138
139
 
# File 'open_search_serverless/cfn_collection.rb', line 137

def creation_stack()
  jsii_get_property("creationStack")
end

#deletion_protection ⇒ String?

The deletion protection state of the collection.

Returns:

  • (String, nil) 


315
316
317
 
# File 'open_search_serverless/cfn_collection.rb', line 315

def deletion_protection()
  jsii_get_property("deletionProtection")
end

#deletion_protection=(value) ⇒ Object 



319
320
321
322
 
# File 'open_search_serverless/cfn_collection.rb', line 319

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

#description ⇒ String?

A description of the collection.

Returns:

  • (String, nil) 


327
328
329
 
# File 'open_search_serverless/cfn_collection.rb', line 327

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



331
332
333
334
 
# File 'open_search_serverless/cfn_collection.rb', line 331

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

#encryption_config ⇒ AWSCDK::IResolvable, ...

Encryption settings for the collection.

Returns:



339
340
341
 
# File 'open_search_serverless/cfn_collection.rb', line 339

def encryption_config()
  jsii_get_property("encryptionConfig")
end

#encryption_config=(value) ⇒ Object 



343
344
345
346
347
 
# File 'open_search_serverless/cfn_collection.rb', line 343

def encryption_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::OpenSearchServerless::CfnCollection::EncryptionConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmVybGVzcy5DZm5Db2xsZWN0aW9uLkVuY3J5cHRpb25Db25maWdQcm9wZXJ0eSJ9XX19")), "encryptionConfig") unless value.nil?
  jsii_set_property("encryptionConfig", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



197
198
199
 
# File 'open_search_serverless/cfn_collection.rb', line 197

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:



604
605
606
607
608
 
# File 'open_search_serverless/cfn_collection.rb', line 604

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:



615
616
617
618
 
# File 'open_search_serverless/cfn_collection.rb', line 615

def get_metadata(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.

Parameters:



685
686
687
688
 
# File 'open_search_serverless/cfn_collection.rb', line 685

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
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) 


149
150
151
 
# File 'open_search_serverless/cfn_collection.rb', line 149

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

The name of the collection.

Returns:

  • (String) 


291
292
293
 
# File 'open_search_serverless/cfn_collection.rb', line 291

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



295
296
297
298
 
# File 'open_search_serverless/cfn_collection.rb', line 295

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  jsii_set_property("name", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


132
133
134
 
# File 'open_search_serverless/cfn_collection.rb', line 132

def node()
  jsii_get_property("node")
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:



626
627
628
 
# File 'open_search_serverless/cfn_collection.rb', line 626

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:



633
634
635
 
# File 'open_search_serverless/cfn_collection.rb', line 633

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.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



426
427
428
429
 
# File 'open_search_serverless/cfn_collection.rb', line 426

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) 


168
169
170
 
# File 'open_search_serverless/cfn_collection.rb', line 168

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:



644
645
646
647
 
# File 'open_search_serverless/cfn_collection.rb', line 644

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


651
652
653
654
 
# File 'open_search_serverless/cfn_collection.rb', line 651

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:



661
662
663
664
665
 
# File 'open_search_serverless/cfn_collection.rb', line 661

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.



670
671
672
 
# File 'open_search_serverless/cfn_collection.rb', line 670

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

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



158
159
160
 
# File 'open_search_serverless/cfn_collection.rb', line 158

def stack()
  jsii_get_property("stack")
end

#standby_replicas ⇒ String?

Indicates whether to use standby replicas for the collection.

Returns:

  • (String, nil) 


352
353
354
 
# File 'open_search_serverless/cfn_collection.rb', line 352

def standby_replicas()
  jsii_get_property("standbyReplicas")
end

#standby_replicas=(value) ⇒ Object 



356
357
358
359
 
# File 'open_search_serverless/cfn_collection.rb', line 356

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

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



284
285
286
 
# File 'open_search_serverless/cfn_collection.rb', line 284

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

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

Returns:



364
365
366
 
# File 'open_search_serverless/cfn_collection.rb', line 364

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



368
369
370
371
372
 
# File 'open_search_serverless/cfn_collection.rb', line 368

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



402
403
404
 
# File 'open_search_serverless/cfn_collection.rb', line 402

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

#type ⇒ String?

The type of collection.

Returns:

  • (String, nil) 


377
378
379
 
# File 'open_search_serverless/cfn_collection.rb', line 377

def type()
  jsii_get_property("type")
end

#type=(value) ⇒ Object 



381
382
383
384
 
# File 'open_search_serverless/cfn_collection.rb', line 381

def type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type") unless value.nil?
  jsii_set_property("type", value)
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}) 


205
206
207
 
# File 'open_search_serverless/cfn_collection.rb', line 205

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


215
216
217
 
# File 'open_search_serverless/cfn_collection.rb', line 215

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


676
677
678
679
 
# File 'open_search_serverless/cfn_collection.rb', line 676

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

#vector_options ⇒ AWSCDK::IResolvable, ...

Vector search configuration options for the collection.

Returns:



389
390
391
 
# File 'open_search_serverless/cfn_collection.rb', line 389

def vector_options()
  jsii_get_property("vectorOptions")
end

#vector_options=(value) ⇒ Object 



393
394
395
396
397
 
# File 'open_search_serverless/cfn_collection.rb', line 393

def vector_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::OpenSearchServerless::CfnCollection::VectorOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmVybGVzcy5DZm5Db2xsZWN0aW9uLlZlY3Rvck9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "vectorOptions") unless value.nil?
  jsii_set_property("vectorOptions", 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) 


415
416
417
418
419
420
 
# File 'open_search_serverless/cfn_collection.rb', line 415

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