Class: AWSCDK::MemoryDB::CfnMultiRegionCluster

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSMemorydb::IMultiRegionClusterRef
Defined in:
memory_db/cfn_multi_region_cluster.rb

Overview

Represents a multi-Region cluster.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnMultiRegionCluster

Create a new AWS::MemoryDB::MultiRegionCluster.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::MemoryDB::CfnMultiRegionClusterProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 18

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

Class Method Details

.arn_for_multi_region_cluster(resource) ⇒ String

Parameters:

Returns:

  • (String) 


83
84
85
86
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 83

def self.arn_for_multi_region_cluster(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19tZW1vcnlkYi5JTXVsdGlSZWdpb25DbHVzdGVyUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_memorydb.CfnMultiRegionCluster", "arnForMultiRegionCluster", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


190
191
192
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 190

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

.is_cfn_multi_region_cluster(x) ⇒ Boolean

Checks whether the given object is a CfnMultiRegionCluster.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


92
93
94
95
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 92

def self.is_cfn_multi_region_cluster(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_memorydb.CfnMultiRegionCluster", "isCfnMultiRegionCluster", [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
 
# File 'memory_db/cfn_multi_region_cluster.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_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_multi_region_cluster_name => { kind: :property, name: "attrMultiRegionClusterName", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :multi_region_cluster_ref => { kind: :property, name: "multiRegionClusterRef", is_optional: false },
    :node_type => { kind: :property, name: "nodeType", is_optional: false },
    :description => { kind: :property, name: "description", is_optional: true },
    :engine => { kind: :property, name: "engine", is_optional: true },
    :engine_version => { kind: :property, name: "engineVersion", is_optional: true },
    :multi_region_cluster_name_suffix => { kind: :property, name: "multiRegionClusterNameSuffix", is_optional: true },
    :multi_region_parameter_group_name => { kind: :property, name: "multiRegionParameterGroupName", is_optional: true },
    :num_shards => { kind: :property, name: "numShards", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :tls_enabled => { kind: :property, name: "tlsEnabled", is_optional: true },
    :update_strategy => { kind: :property, name: "updateStrategy", 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.



386
387
388
389
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 386

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:



398
399
400
401
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 398

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:



408
409
410
411
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 408

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:



419
420
421
422
423
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 419

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.


476
477
478
479
480
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 476

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.



486
487
488
489
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 486

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.



498
499
500
501
502
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 498

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:



511
512
513
514
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 511

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:



533
534
535
536
537
538
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 533

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 multi-Region cluster.

Returns:

  • (String) 


197
198
199
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 197

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_multi_region_cluster_name ⇒ String

The name of the multi-Region cluster.

Returns:

  • (String) 


204
205
206
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 204

def attr_multi_region_cluster_name()
  jsii_get_property("attrMultiRegionClusterName")
end

#attr_status ⇒ String

The current status of the multi-Region cluster.

Returns:

  • (String) 


211
212
213
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 211

def attr_status()
  jsii_get_property("attrStatus")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



218
219
220
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 218

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



143
144
145
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 143

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


148
149
150
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 148

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


542
543
544
545
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 542

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


153
154
155
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 153

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


160
161
162
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 160

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


105
106
107
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 105

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

The description of the multi-Region cluster.

Returns:

  • (String, nil) 


244
245
246
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 244

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



248
249
250
251
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 248

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

#engine ⇒ String?

The name of the engine used by the multi-Region cluster.

Returns:

  • (String, nil) 


256
257
258
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 256

def engine()
  jsii_get_property("engine")
end

#engine=(value) ⇒ Object 



260
261
262
263
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 260

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

#engine_version ⇒ String?

The version of the engine used by the multi-Region cluster.

Returns:

  • (String, nil) 


268
269
270
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 268

def engine_version()
  jsii_get_property("engineVersion")
end

#engine_version=(value) ⇒ Object 



272
273
274
275
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 272

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:



165
166
167
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 165

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:



555
556
557
558
559
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 555

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:



566
567
568
569
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 566

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:



636
637
638
639
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 636

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) 


117
118
119
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 117

def logical_id()
  jsii_get_property("logicalId")
end

#multi_region_cluster_name_suffix ⇒ String?

A suffix to be added to the Multi-Region cluster name.

Returns:

  • (String, nil) 


280
281
282
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 280

def multi_region_cluster_name_suffix()
  jsii_get_property("multiRegionClusterNameSuffix")
end

#multi_region_cluster_name_suffix=(value) ⇒ Object 



284
285
286
287
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 284

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

#multi_region_cluster_ref ⇒ AWSCDK::Interfaces::AWSMemorydb::MultiRegionClusterReference

A reference to a MultiRegionCluster resource.

Returns:



225
226
227
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 225

def multi_region_cluster_ref()
  jsii_get_property("multiRegionClusterRef")
end

#multi_region_parameter_group_name ⇒ String?

The name of the multi-Region parameter group associated with the cluster.

Returns:

  • (String, nil) 


292
293
294
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 292

def multi_region_parameter_group_name()
  jsii_get_property("multiRegionParameterGroupName")
end

#multi_region_parameter_group_name=(value) ⇒ Object 



296
297
298
299
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 296

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


100
101
102
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 100

def node()
  jsii_get_property("node")
end

#node_type ⇒ String

The node type used by the multi-Region cluster.

Returns:

  • (String) 


232
233
234
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 232

def node_type()
  jsii_get_property("nodeType")
end

#node_type=(value) ⇒ Object 



236
237
238
239
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 236

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

#num_shards ⇒ Numeric?

The number of shards in the multi-Region cluster.

Returns:

  • (Numeric, nil) 


304
305
306
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 304

def num_shards()
  jsii_get_property("numShards")
end

#num_shards=(value) ⇒ Object 



308
309
310
311
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 308

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



577
578
579
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 577

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:



584
585
586
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 584

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.



377
378
379
380
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 377

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) 


136
137
138
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 136

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:



595
596
597
598
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 595

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


602
603
604
605
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 602

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:



612
613
614
615
616
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 612

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.



621
622
623
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 621

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:



126
127
128
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 126

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

A list of tags to be applied to the multi-Region cluster.

Returns:



316
317
318
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 316

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



320
321
322
323
324
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 320

def tags=(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=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#tls_enabled ⇒ Boolean, ...

Indiciates if the multi-Region cluster is TLS enabled.

Returns:



329
330
331
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 329

def tls_enabled()
  jsii_get_property("tlsEnabled")
end

#tls_enabled=(value) ⇒ Object 



333
334
335
336
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 333

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



353
354
355
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 353

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

#update_strategy ⇒ String?

The strategy to use for the update operation.

Returns:

  • (String, nil) 


341
342
343
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 341

def update_strategy()
  jsii_get_property("updateStrategy")
end

#update_strategy=(value) ⇒ Object 



345
346
347
348
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 345

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


173
174
175
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 173

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


183
184
185
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 183

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


627
628
629
630
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 627

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
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) 


366
367
368
369
370
371
 
# File 'memory_db/cfn_multi_region_cluster.rb', line 366

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