Class: AWSCDK::DocDB::CfnDBCluster

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSDocdb::IDBClusterRef
Defined in:
doc_db/cfn_db_cluster.rb

Overview

The AWS::DocDB::DBCluster Amazon DocumentDB (with MongoDB compatibility) resource describes a DBCluster.

Amazon DocumentDB is a fully managed, MongoDB-compatible document database engine. For more information, see DBCluster in the Amazon DocumentDB Developer Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Create a new AWS::DocDB::DBCluster.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::DocDB::CfnDBClusterProps, nil) (defaults to: nil) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'doc_db/cfn_db_cluster.rb', line 20

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

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


207
208
209
 
# File 'doc_db/cfn_db_cluster.rb', line 207

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

.is_cfn_db_cluster(x) ⇒ Boolean

Checks whether the given object is a CfnDBCluster.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


109
110
111
112
 
# File 'doc_db/cfn_db_cluster.rb', line 109

def self.is_cfn_db_cluster(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_docdb.CfnDBCluster", "isCfnDBCluster", [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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'doc_db/cfn_db_cluster.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_cluster_resource_id => { kind: :property, name: "attrClusterResourceId", is_optional: false },
    :attr_endpoint => { kind: :property, name: "attrEndpoint", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_port => { kind: :property, name: "attrPort", is_optional: false },
    :attr_read_endpoint => { kind: :property, name: "attrReadEndpoint", is_optional: false },
    :db_cluster_ref => { kind: :property, name: "dbClusterRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :availability_zones => { kind: :property, name: "availabilityZones", is_optional: true },
    :backup_retention_period => { kind: :property, name: "backupRetentionPeriod", is_optional: true },
    :copy_tags_to_snapshot => { kind: :property, name: "copyTagsToSnapshot", is_optional: true },
    :db_cluster_identifier => { kind: :property, name: "dbClusterIdentifier", is_optional: true },
    :db_cluster_parameter_group_name => { kind: :property, name: "dbClusterParameterGroupName", is_optional: true },
    :db_subnet_group_name => { kind: :property, name: "dbSubnetGroupName", is_optional: true },
    :deletion_protection => { kind: :property, name: "deletionProtection", is_optional: true },
    :enable_cloudwatch_logs_exports => { kind: :property, name: "enableCloudwatchLogsExports", is_optional: true },
    :engine_version => { kind: :property, name: "engineVersion", is_optional: true },
    :global_cluster_identifier => { kind: :property, name: "globalClusterIdentifier", is_optional: true },
    :kms_key_id => { kind: :property, name: "kmsKeyId", is_optional: true },
    :manage_master_user_password => { kind: :property, name: "manageMasterUserPassword", is_optional: true },
    :master_username => { kind: :property, name: "masterUsername", is_optional: true },
    :master_user_password => { kind: :property, name: "masterUserPassword", is_optional: true },
    :master_user_secret_kms_key_id => { kind: :property, name: "masterUserSecretKmsKeyId", is_optional: true },
    :network_type => { kind: :property, name: "networkType", is_optional: true },
    :port => { kind: :property, name: "port", is_optional: true },
    :preferred_backup_window => { kind: :property, name: "preferredBackupWindow", is_optional: true },
    :preferred_maintenance_window => { kind: :property, name: "preferredMaintenanceWindow", is_optional: true },
    :restore_to_time => { kind: :property, name: "restoreToTime", is_optional: true },
    :restore_type => { kind: :property, name: "restoreType", is_optional: true },
    :rotate_master_user_password => { kind: :property, name: "rotateMasterUserPassword", is_optional: true },
    :serverless_v2_scaling_configuration => { kind: :property, name: "serverlessV2ScalingConfiguration", is_optional: true },
    :snapshot_identifier => { kind: :property, name: "snapshotIdentifier", is_optional: true },
    :source_db_cluster_identifier => { kind: :property, name: "sourceDbClusterIdentifier", is_optional: true },
    :storage_encrypted => { kind: :property, name: "storageEncrypted", is_optional: true },
    :storage_type => { kind: :property, name: "storageType", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :use_latest_restorable_time => { kind: :property, name: "useLatestRestorableTime", is_optional: true },
    :vpc_security_group_ids => { kind: :property, name: "vpcSecurityGroupIds", 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.



668
669
670
671
 
# File 'doc_db/cfn_db_cluster.rb', line 668

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:



680
681
682
683
 
# File 'doc_db/cfn_db_cluster.rb', line 680

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:



690
691
692
693
 
# File 'doc_db/cfn_db_cluster.rb', line 690

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:



701
702
703
704
705
 
# File 'doc_db/cfn_db_cluster.rb', line 701

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.


758
759
760
761
762
 
# File 'doc_db/cfn_db_cluster.rb', line 758

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.



768
769
770
771
 
# File 'doc_db/cfn_db_cluster.rb', line 768

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.



780
781
782
783
784
 
# File 'doc_db/cfn_db_cluster.rb', line 780

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:



793
794
795
796
 
# File 'doc_db/cfn_db_cluster.rb', line 793

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:



815
816
817
818
819
820
 
# File 'doc_db/cfn_db_cluster.rb', line 815

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

The resource id for the cluster;

for example: cluster-ABCD1234EFGH5678IJKL90MNOP . The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.

Returns:

  • (String) 


216
217
218
 
# File 'doc_db/cfn_db_cluster.rb', line 216

def attr_cluster_resource_id()
  jsii_get_property("attrClusterResourceId")
end

#attr_endpoint ⇒ String

The connection endpoint for the cluster, such as sample-cluster.cluster-cozrlsfrcjoc.us-east-1.docdb.amazonaws.com .

Returns:

  • (String) 


223
224
225
 
# File 'doc_db/cfn_db_cluster.rb', line 223

def attr_endpoint()
  jsii_get_property("attrEndpoint")
end

#attr_id ⇒ String

Returns:

  • (String) 


228
229
230
 
# File 'doc_db/cfn_db_cluster.rb', line 228

def attr_id()
  jsii_get_property("attrId")
end

#attr_port ⇒ String

The port number on which the cluster accepts connections.

For example: 27017 .

Returns:

  • (String) 


237
238
239
 
# File 'doc_db/cfn_db_cluster.rb', line 237

def attr_port()
  jsii_get_property("attrPort")
end

#attr_read_endpoint ⇒ String

The reader endpoint for the cluster.

For example: sample-cluster.cluster-ro-cozrlsfrcjoc.us-east-1.docdb.amazonaws.com .

Returns:

  • (String) 


246
247
248
 
# File 'doc_db/cfn_db_cluster.rb', line 246

def attr_read_endpoint()
  jsii_get_property("attrReadEndpoint")
end

#availability_zones ⇒ Array<String>?

A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

Returns:

  • (Array<String>, nil) 


267
268
269
 
# File 'doc_db/cfn_db_cluster.rb', line 267

def availability_zones()
  jsii_get_property("availabilityZones")
end

#availability_zones=(value) ⇒ Object 



271
272
273
274
 
# File 'doc_db/cfn_db_cluster.rb', line 271

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

#backup_retention_period ⇒ Numeric?

The number of days for which automated backups are retained.

You must specify a minimum value of 1.

Returns:

  • (Numeric, nil) 


281
282
283
 
# File 'doc_db/cfn_db_cluster.rb', line 281

def backup_retention_period()
  jsii_get_property("backupRetentionPeriod")
end

#backup_retention_period=(value) ⇒ Object 



285
286
287
288
 
# File 'doc_db/cfn_db_cluster.rb', line 285

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



160
161
162
 
# File 'doc_db/cfn_db_cluster.rb', line 160

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


165
166
167
 
# File 'doc_db/cfn_db_cluster.rb', line 165

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


824
825
826
827
 
# File 'doc_db/cfn_db_cluster.rb', line 824

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


170
171
172
 
# File 'doc_db/cfn_db_cluster.rb', line 170

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


177
178
179
 
# File 'doc_db/cfn_db_cluster.rb', line 177

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#copy_tags_to_snapshot ⇒ Boolean, ...

Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false .

Returns:



293
294
295
 
# File 'doc_db/cfn_db_cluster.rb', line 293

def copy_tags_to_snapshot()
  jsii_get_property("copyTagsToSnapshot")
end

#copy_tags_to_snapshot=(value) ⇒ Object 



297
298
299
300
 
# File 'doc_db/cfn_db_cluster.rb', line 297

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


122
123
124
 
# File 'doc_db/cfn_db_cluster.rb', line 122

def creation_stack()
  jsii_get_property("creationStack")
end

#db_cluster_identifier ⇒ String?

The cluster identifier.

This parameter is stored as a lowercase string.

Returns:

  • (String, nil) 


307
308
309
 
# File 'doc_db/cfn_db_cluster.rb', line 307

def db_cluster_identifier()
  jsii_get_property("dbClusterIdentifier")
end

#db_cluster_identifier=(value) ⇒ Object 



311
312
313
314
 
# File 'doc_db/cfn_db_cluster.rb', line 311

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

#db_cluster_parameter_group_name ⇒ String?

The name of the cluster parameter group to associate with this cluster.

Returns:

  • (String, nil) 


319
320
321
 
# File 'doc_db/cfn_db_cluster.rb', line 319

def db_cluster_parameter_group_name()
  jsii_get_property("dbClusterParameterGroupName")
end

#db_cluster_parameter_group_name=(value) ⇒ Object 



323
324
325
326
 
# File 'doc_db/cfn_db_cluster.rb', line 323

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

#db_cluster_ref ⇒ AWSCDK::Interfaces::AWSDocdb::DBClusterReference

A reference to a DBCluster resource.

Returns:



253
254
255
 
# File 'doc_db/cfn_db_cluster.rb', line 253

def db_cluster_ref()
  jsii_get_property("dbClusterRef")
end

#db_subnet_group_name ⇒ String?

A subnet group to associate with this cluster.

Returns:

  • (String, nil) 


331
332
333
 
# File 'doc_db/cfn_db_cluster.rb', line 331

def db_subnet_group_name()
  jsii_get_property("dbSubnetGroupName")
end

#db_subnet_group_name=(value) ⇒ Object 



335
336
337
338
 
# File 'doc_db/cfn_db_cluster.rb', line 335

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

#deletion_protection ⇒ Boolean, ...

Protects clusters from being accidentally deleted.

Returns:



343
344
345
 
# File 'doc_db/cfn_db_cluster.rb', line 343

def deletion_protection()
  jsii_get_property("deletionProtection")
end

#deletion_protection=(value) ⇒ Object 



347
348
349
350
 
# File 'doc_db/cfn_db_cluster.rb', line 347

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

#enable_cloudwatch_logs_exports ⇒ Array<String>?

The list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.

Returns:

  • (Array<String>, nil) 


355
356
357
 
# File 'doc_db/cfn_db_cluster.rb', line 355

def enable_cloudwatch_logs_exports()
  jsii_get_property("enableCloudwatchLogsExports")
end

#enable_cloudwatch_logs_exports=(value) ⇒ Object 



359
360
361
362
 
# File 'doc_db/cfn_db_cluster.rb', line 359

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

#engine_version ⇒ String?

The version number of the database engine to use.

Returns:

  • (String, nil) 


367
368
369
 
# File 'doc_db/cfn_db_cluster.rb', line 367

def engine_version()
  jsii_get_property("engineVersion")
end

#engine_version=(value) ⇒ Object 



371
372
373
374
 
# File 'doc_db/cfn_db_cluster.rb', line 371

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:



182
183
184
 
# File 'doc_db/cfn_db_cluster.rb', line 182

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:



837
838
839
840
841
 
# File 'doc_db/cfn_db_cluster.rb', line 837

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:



848
849
850
851
 
# File 'doc_db/cfn_db_cluster.rb', line 848

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

#global_cluster_identifier ⇒ String?

The cluster identifier of the new global cluster.

Returns:

  • (String, nil) 


379
380
381
 
# File 'doc_db/cfn_db_cluster.rb', line 379

def global_cluster_identifier()
  jsii_get_property("globalClusterIdentifier")
end

#global_cluster_identifier=(value) ⇒ Object 



383
384
385
386
 
# File 'doc_db/cfn_db_cluster.rb', line 383

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



918
919
920
921
 
# File 'doc_db/cfn_db_cluster.rb', line 918

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

#kms_key_id ⇒ String?

The AWS key identifier for an encrypted cluster.

Returns:

  • (String, nil) 


391
392
393
 
# File 'doc_db/cfn_db_cluster.rb', line 391

def kms_key_id()
  jsii_get_property("kmsKeyId")
end

#kms_key_id=(value) ⇒ Object 



395
396
397
398
 
# File 'doc_db/cfn_db_cluster.rb', line 395

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

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

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

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


134
135
136
 
# File 'doc_db/cfn_db_cluster.rb', line 134

def logical_id()
  jsii_get_property("logicalId")
end

#manage_master_user_password ⇒ Boolean, ...

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

Returns:



403
404
405
 
# File 'doc_db/cfn_db_cluster.rb', line 403

def manage_master_user_password()
  jsii_get_property("manageMasterUserPassword")
end

#manage_master_user_password=(value) ⇒ Object 



407
408
409
410
 
# File 'doc_db/cfn_db_cluster.rb', line 407

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

#master_user_password ⇒ String?

The password for the master database user.

Returns:

  • (String, nil) 


427
428
429
 
# File 'doc_db/cfn_db_cluster.rb', line 427

def master_user_password()
  jsii_get_property("masterUserPassword")
end

#master_user_password=(value) ⇒ Object 



431
432
433
434
 
# File 'doc_db/cfn_db_cluster.rb', line 431

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

#master_user_secret_kms_key_id ⇒ String?

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

Returns:

  • (String, nil) 


439
440
441
 
# File 'doc_db/cfn_db_cluster.rb', line 439

def master_user_secret_kms_key_id()
  jsii_get_property("masterUserSecretKmsKeyId")
end

#master_user_secret_kms_key_id=(value) ⇒ Object 



443
444
445
446
 
# File 'doc_db/cfn_db_cluster.rb', line 443

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

#master_username ⇒ String?

The name of the master user for the cluster.

Returns:

  • (String, nil) 


415
416
417
 
# File 'doc_db/cfn_db_cluster.rb', line 415

def master_username()
  jsii_get_property("masterUsername")
end

#master_username=(value) ⇒ Object 



419
420
421
422
 
# File 'doc_db/cfn_db_cluster.rb', line 419

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

#network_type ⇒ String?

The network type of the cluster.

Returns:

  • (String, nil) 


451
452
453
 
# File 'doc_db/cfn_db_cluster.rb', line 451

def network_type()
  jsii_get_property("networkType")
end

#network_type=(value) ⇒ Object 



455
456
457
458
 
# File 'doc_db/cfn_db_cluster.rb', line 455

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


117
118
119
 
# File 'doc_db/cfn_db_cluster.rb', line 117

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:



859
860
861
 
# File 'doc_db/cfn_db_cluster.rb', line 859

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:



866
867
868
 
# File 'doc_db/cfn_db_cluster.rb', line 866

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.



659
660
661
662
 
# File 'doc_db/cfn_db_cluster.rb', line 659

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

#port ⇒ Numeric?

Specifies the port that the database engine is listening on.

Returns:

  • (Numeric, nil) 


463
464
465
 
# File 'doc_db/cfn_db_cluster.rb', line 463

def port()
  jsii_get_property("port")
end

#port=(value) ⇒ Object 



467
468
469
470
 
# File 'doc_db/cfn_db_cluster.rb', line 467

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

#preferred_backup_window ⇒ String?

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

Returns:

  • (String, nil) 


475
476
477
 
# File 'doc_db/cfn_db_cluster.rb', line 475

def preferred_backup_window()
  jsii_get_property("preferredBackupWindow")
end

#preferred_backup_window=(value) ⇒ Object 



479
480
481
482
 
# File 'doc_db/cfn_db_cluster.rb', line 479

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

#preferred_maintenance_window ⇒ String?

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Returns:

  • (String, nil) 


487
488
489
 
# File 'doc_db/cfn_db_cluster.rb', line 487

def preferred_maintenance_window()
  jsii_get_property("preferredMaintenanceWindow")
end

#preferred_maintenance_window=(value) ⇒ Object 



491
492
493
494
 
# File 'doc_db/cfn_db_cluster.rb', line 491

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


153
154
155
 
# File 'doc_db/cfn_db_cluster.rb', line 153

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:



877
878
879
880
 
# File 'doc_db/cfn_db_cluster.rb', line 877

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


884
885
886
887
 
# File 'doc_db/cfn_db_cluster.rb', line 884

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:



894
895
896
897
898
 
# File 'doc_db/cfn_db_cluster.rb', line 894

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

#restore_to_time ⇒ String?

The date and time to restore the cluster to.

Returns:

  • (String, nil) 


499
500
501
 
# File 'doc_db/cfn_db_cluster.rb', line 499

def restore_to_time()
  jsii_get_property("restoreToTime")
end

#restore_to_time=(value) ⇒ Object 



503
504
505
506
 
# File 'doc_db/cfn_db_cluster.rb', line 503

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

#restore_type ⇒ String?

The type of restore to be performed.

You can specify one of the following values:.

Returns:

  • (String, nil) 


513
514
515
 
# File 'doc_db/cfn_db_cluster.rb', line 513

def restore_type()
  jsii_get_property("restoreType")
end

#restore_type=(value) ⇒ Object 



517
518
519
520
 
# File 'doc_db/cfn_db_cluster.rb', line 517

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

#rotate_master_user_password ⇒ Boolean, ...

Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.

Returns:



525
526
527
 
# File 'doc_db/cfn_db_cluster.rb', line 525

def rotate_master_user_password()
  jsii_get_property("rotateMasterUserPassword")
end

#rotate_master_user_password=(value) ⇒ Object 



529
530
531
532
 
# File 'doc_db/cfn_db_cluster.rb', line 529

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

#serverless_v2_scaling_configuration ⇒ AWSCDK::IResolvable, ...

Contains the scaling configuration of an Amazon DocumentDB Serverless cluster.

Returns:



537
538
539
 
# File 'doc_db/cfn_db_cluster.rb', line 537

def serverless_v2_scaling_configuration()
  jsii_get_property("serverlessV2ScalingConfiguration")
end

#serverless_v2_scaling_configuration=(value) ⇒ Object 



541
542
543
544
545
 
# File 'doc_db/cfn_db_cluster.rb', line 541

def serverless_v2_scaling_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DocDB::CfnDBCluster::ServerlessV2ScalingConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kb2NkYi5DZm5EQkNsdXN0ZXIuU2VydmVybGVzc1YyU2NhbGluZ0NvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "serverlessV2ScalingConfiguration") unless value.nil?
  jsii_set_property("serverlessV2ScalingConfiguration", value)
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.



903
904
905
 
# File 'doc_db/cfn_db_cluster.rb', line 903

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

#snapshot_identifier ⇒ String?

The identifier for the snapshot or cluster snapshot to restore from.

Returns:

  • (String, nil) 


550
551
552
 
# File 'doc_db/cfn_db_cluster.rb', line 550

def snapshot_identifier()
  jsii_get_property("snapshotIdentifier")
end

#snapshot_identifier=(value) ⇒ Object 



554
555
556
557
 
# File 'doc_db/cfn_db_cluster.rb', line 554

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

#source_db_cluster_identifier ⇒ String?

The identifier of the source cluster from which to restore.

Returns:

  • (String, nil) 


562
563
564
 
# File 'doc_db/cfn_db_cluster.rb', line 562

def source_db_cluster_identifier()
  jsii_get_property("sourceDbClusterIdentifier")
end

#source_db_cluster_identifier=(value) ⇒ Object 



566
567
568
569
 
# File 'doc_db/cfn_db_cluster.rb', line 566

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

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



143
144
145
 
# File 'doc_db/cfn_db_cluster.rb', line 143

def stack()
  jsii_get_property("stack")
end

#storage_encrypted ⇒ Boolean, ...

Specifies whether the cluster is encrypted.

Returns:



574
575
576
 
# File 'doc_db/cfn_db_cluster.rb', line 574

def storage_encrypted()
  jsii_get_property("storageEncrypted")
end

#storage_encrypted=(value) ⇒ Object 



578
579
580
581
 
# File 'doc_db/cfn_db_cluster.rb', line 578

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

#storage_type ⇒ String?

The storage type to associate with the DB cluster.

Returns:

  • (String, nil) 


586
587
588
 
# File 'doc_db/cfn_db_cluster.rb', line 586

def storage_type()
  jsii_get_property("storageType")
end

#storage_type=(value) ⇒ Object 



590
591
592
593
 
# File 'doc_db/cfn_db_cluster.rb', line 590

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

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



260
261
262
 
# File 'doc_db/cfn_db_cluster.rb', line 260

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

The tags to be assigned to the cluster.

Returns:



598
599
600
 
# File 'doc_db/cfn_db_cluster.rb', line 598

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



602
603
604
605
606
 
# File 'doc_db/cfn_db_cluster.rb', line 602

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



635
636
637
 
# File 'doc_db/cfn_db_cluster.rb', line 635

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

#updated_properites ⇒ Hash{String => Object}

Deprecated.

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

Deprecated.

Returns:

  • (Hash{String => Object}) 


190
191
192
 
# File 'doc_db/cfn_db_cluster.rb', line 190

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


200
201
202
 
# File 'doc_db/cfn_db_cluster.rb', line 200

def updated_properties()
  jsii_get_property("updatedProperties")
end

#use_latest_restorable_time ⇒ Boolean, ...

A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise.

Returns:



611
612
613
 
# File 'doc_db/cfn_db_cluster.rb', line 611

def use_latest_restorable_time()
  jsii_get_property("useLatestRestorableTime")
end

#use_latest_restorable_time=(value) ⇒ Object 



615
616
617
618
 
# File 'doc_db/cfn_db_cluster.rb', line 615

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

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


909
910
911
912
 
# File 'doc_db/cfn_db_cluster.rb', line 909

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

#vpc_security_group_ids ⇒ Array<String>?

A list of EC2 VPC security groups to associate with this cluster.

Returns:

  • (Array<String>, nil) 


623
624
625
 
# File 'doc_db/cfn_db_cluster.rb', line 623

def vpc_security_group_ids()
  jsii_get_property("vpcSecurityGroupIds")
end

#vpc_security_group_ids=(value) ⇒ Object 



627
628
629
630
 
# File 'doc_db/cfn_db_cluster.rb', line 627

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


648
649
650
651
652
653
 
# File 'doc_db/cfn_db_cluster.rb', line 648

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