Class: AWSCDK::RDS::CfnDBCluster

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

Overview

The AWS::RDS::DBCluster resource creates an Amazon Aurora DB cluster or Multi-AZ DB cluster.

For more information about creating an Aurora DB cluster, see Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide .

For more information about creating a Multi-AZ DB cluster, see Creating a Multi-AZ DB cluster in the Amazon RDS User Guide .

You can only create this resource in AWS Regions where Amazon Aurora or Multi-AZ DB clusters are supported.

Updating DB clusters

When properties labeled " Update requires: Replacement " are updated, AWS CloudFormation first creates a replacement DB cluster, then changes references from other dependent resources to point to the replacement DB cluster, and finally deletes the old DB cluster.

We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB cluster. To preserve your data, perform the following procedure:

  • Deactivate any applications that are using the DB cluster so that there's no activity on the DB instance.
  • Create a snapshot of the DB cluster. For more information, see Creating a DB cluster snapshot .
  • If you want to restore your DB cluster using a DB cluster snapshot, modify the updated template with your DB cluster changes and add the SnapshotIdentifier property with the ID of the DB cluster snapshot that you want to use.

After you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the DB cluster snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted.

  • Update the stack.

Currently, when you are updating the stack for an Aurora Serverless DB cluster, you can't include changes to any other properties when you specify one of the following properties: PreferredBackupWindow , PreferredMaintenanceWindow , and Port . This limitation doesn't apply to provisioned DB clusters.

For more information about updating other properties of this resource, see [ModifyDBCluster](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_ModifyDBCluster.html) . For more information about updating stacks, see AWS CloudFormation Stacks Updates .

Deleting DB clusters

The default DeletionPolicy for AWS::RDS::DBCluster resources is Snapshot . For more information about how AWS CloudFormation deletes resources, see DeletionPolicy Attribute .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Create a new AWS::RDS::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::RDS::CfnDBClusterProps, nil) (defaults to: nil) —

    Resource properties.



46
47
48
49
50
51
52
 
# File 'rds/cfn_db_cluster.rb', line 46

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

Class Method Details

.arn_for_db_cluster(resource) ⇒ String

Parameters:

Returns:

  • (String) 


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

def self.arn_for_db_cluster(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19yZHMuSURCQ2x1c3RlclJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_rds.CfnDBCluster", "arnForDBCluster", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


276
277
278
 
# File 'rds/cfn_db_cluster.rb', line 276

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_rds.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) 


178
179
180
181
 
# File 'rds/cfn_db_cluster.rb', line 178

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_rds.CfnDBCluster", "isCfnDBCluster", [x])
end

.jsii_overridable_methods ⇒ Object 



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'rds/cfn_db_cluster.rb', line 54

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_db_cluster_arn => { kind: :property, name: "attrDbClusterArn", is_optional: false },
    :attr_db_cluster_resource_id => { kind: :property, name: "attrDbClusterResourceId", is_optional: false },
    :attr_endpoint => { kind: :property, name: "attrEndpoint", is_optional: false },
    :attr_endpoint_address => { kind: :property, name: "attrEndpointAddress", is_optional: false },
    :attr_endpoint_port => { kind: :property, name: "attrEndpointPort", is_optional: false },
    :attr_master_user_secret_secret_arn => { kind: :property, name: "attrMasterUserSecretSecretArn", is_optional: false },
    :attr_read_endpoint => { kind: :property, name: "attrReadEndpoint", is_optional: false },
    :attr_read_endpoint_address => { kind: :property, name: "attrReadEndpointAddress", is_optional: false },
    :attr_storage_encryption_type => { kind: :property, name: "attrStorageEncryptionType", is_optional: false },
    :attr_storage_throughput => { kind: :property, name: "attrStorageThroughput", is_optional: false },
    :db_cluster_ref => { kind: :property, name: "dbClusterRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :allocated_storage => { kind: :property, name: "allocatedStorage", is_optional: true },
    :associated_roles => { kind: :property, name: "associatedRoles", is_optional: true },
    :auto_minor_version_upgrade => { kind: :property, name: "autoMinorVersionUpgrade", is_optional: true },
    :availability_zones => { kind: :property, name: "availabilityZones", is_optional: true },
    :backtrack_window => { kind: :property, name: "backtrackWindow", is_optional: true },
    :backup_retention_period => { kind: :property, name: "backupRetentionPeriod", is_optional: true },
    :cluster_scalability_type => { kind: :property, name: "clusterScalabilityType", is_optional: true },
    :copy_tags_to_snapshot => { kind: :property, name: "copyTagsToSnapshot", is_optional: true },
    :database_insights_mode => { kind: :property, name: "databaseInsightsMode", is_optional: true },
    :database_name => { kind: :property, name: "databaseName", is_optional: true },
    :db_cluster_identifier => { kind: :property, name: "dbClusterIdentifier", is_optional: true },
    :db_cluster_instance_class => { kind: :property, name: "dbClusterInstanceClass", is_optional: true },
    :db_cluster_parameter_group_name => { kind: :property, name: "dbClusterParameterGroupName", is_optional: true },
    :db_instance_parameter_group_name => { kind: :property, name: "dbInstanceParameterGroupName", is_optional: true },
    :db_subnet_group_name => { kind: :property, name: "dbSubnetGroupName", is_optional: true },
    :db_system_id => { kind: :property, name: "dbSystemId", is_optional: true },
    :delete_automated_backups => { kind: :property, name: "deleteAutomatedBackups", is_optional: true },
    :deletion_protection => { kind: :property, name: "deletionProtection", is_optional: true },
    :domain => { kind: :property, name: "domain", is_optional: true },
    :domain_iam_role_name => { kind: :property, name: "domainIamRoleName", is_optional: true },
    :enable_cloudwatch_logs_exports => { kind: :property, name: "enableCloudwatchLogsExports", is_optional: true },
    :enable_global_write_forwarding => { kind: :property, name: "enableGlobalWriteForwarding", is_optional: true },
    :enable_http_endpoint => { kind: :property, name: "enableHttpEndpoint", is_optional: true },
    :enable_iam_database_authentication => { kind: :property, name: "enableIamDatabaseAuthentication", is_optional: true },
    :enable_local_write_forwarding => { kind: :property, name: "enableLocalWriteForwarding", is_optional: true },
    :engine => { kind: :property, name: "engine", is_optional: true },
    :engine_lifecycle_support => { kind: :property, name: "engineLifecycleSupport", is_optional: true },
    :engine_mode => { kind: :property, name: "engineMode", is_optional: true },
    :engine_version => { kind: :property, name: "engineVersion", is_optional: true },
    :global_cluster_identifier => { kind: :property, name: "globalClusterIdentifier", is_optional: true },
    :iops => { kind: :property, name: "iops", 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_user_authentication_type => { kind: :property, name: "masterUserAuthenticationType", 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 => { kind: :property, name: "masterUserSecret", is_optional: true },
    :monitoring_interval => { kind: :property, name: "monitoringInterval", is_optional: true },
    :monitoring_role_arn => { kind: :property, name: "monitoringRoleArn", is_optional: true },
    :network_type => { kind: :property, name: "networkType", is_optional: true },
    :performance_insights_enabled => { kind: :property, name: "performanceInsightsEnabled", is_optional: true },
    :performance_insights_kms_key_id => { kind: :property, name: "performanceInsightsKmsKeyId", is_optional: true },
    :performance_insights_retention_period => { kind: :property, name: "performanceInsightsRetentionPeriod", 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 },
    :publicly_accessible => { kind: :property, name: "publiclyAccessible", is_optional: true },
    :replication_source_identifier => { kind: :property, name: "replicationSourceIdentifier", is_optional: true },
    :restore_to_time => { kind: :property, name: "restoreToTime", is_optional: true },
    :restore_type => { kind: :property, name: "restoreType", is_optional: true },
    :scaling_configuration => { kind: :property, name: "scalingConfiguration", 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 },
    :source_db_cluster_resource_id => { kind: :property, name: "sourceDbClusterResourceId", is_optional: true },
    :source_region => { kind: :property, name: "sourceRegion", 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.



1160
1161
1162
1163
 
# File 'rds/cfn_db_cluster.rb', line 1160

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:



1172
1173
1174
1175
 
# File 'rds/cfn_db_cluster.rb', line 1172

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:



1182
1183
1184
1185
 
# File 'rds/cfn_db_cluster.rb', line 1182

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:



1193
1194
1195
1196
1197
 
# File 'rds/cfn_db_cluster.rb', line 1193

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.


1250
1251
1252
1253
1254
 
# File 'rds/cfn_db_cluster.rb', line 1250

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.



1260
1261
1262
1263
 
# File 'rds/cfn_db_cluster.rb', line 1260

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.



1272
1273
1274
1275
1276
 
# File 'rds/cfn_db_cluster.rb', line 1272

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

#allocated_storage ⇒ Numeric?

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

Returns:

  • (Numeric, nil) 


381
382
383
 
# File 'rds/cfn_db_cluster.rb', line 381

def allocated_storage()
  jsii_get_property("allocatedStorage")
end

#allocated_storage=(value) ⇒ Object 



385
386
387
388
 
# File 'rds/cfn_db_cluster.rb', line 385

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



1285
1286
1287
1288
 
# File 'rds/cfn_db_cluster.rb', line 1285

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:



1307
1308
1309
1310
1311
1312
 
# File 'rds/cfn_db_cluster.rb', line 1307

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

#associated_roles ⇒ AWSCDK::IResolvable, ...

Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.

Returns:



393
394
395
 
# File 'rds/cfn_db_cluster.rb', line 393

def associated_roles()
  jsii_get_property("associatedRoles")
end

#associated_roles=(value) ⇒ Object 



397
398
399
400
 
# File 'rds/cfn_db_cluster.rb', line 397

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

#attr_db_cluster_arn ⇒ String

The Amazon Resource Name (ARN) for the DB cluster.

Returns:

  • (String) 


283
284
285
 
# File 'rds/cfn_db_cluster.rb', line 283

def attr_db_cluster_arn()
  jsii_get_property("attrDbClusterArn")
end

#attr_db_cluster_resource_id ⇒ String

The AWS Region -unique, immutable identifier for the DB cluster.

This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

Returns:

  • (String) 


292
293
294
 
# File 'rds/cfn_db_cluster.rb', line 292

def attr_db_cluster_resource_id()
  jsii_get_property("attrDbClusterResourceId")
end

#attr_endpoint ⇒ AWSCDK::IResolvable

The Endpoint return value specifies the connection endpoint for the primary instance of the DB cluster.

Returns:



299
300
301
 
# File 'rds/cfn_db_cluster.rb', line 299

def attr_endpoint()
  jsii_get_property("attrEndpoint")
end

#attr_endpoint_address ⇒ String

The connection endpoint for the DB cluster.

For example: mystack-mydbcluster-123456789012.us-east-2.rds.amazonaws.com

Returns:

  • (String) 


308
309
310
 
# File 'rds/cfn_db_cluster.rb', line 308

def attr_endpoint_address()
  jsii_get_property("attrEndpointAddress")
end

#attr_endpoint_port ⇒ String

The port number that will accept connections on this DB cluster.

For example: 3306

Returns:

  • (String) 


317
318
319
 
# File 'rds/cfn_db_cluster.rb', line 317

def attr_endpoint_port()
  jsii_get_property("attrEndpointPort")
end

#attr_master_user_secret_secret_arn ⇒ String

The Amazon Resource Name (ARN) of the secret.

Returns:

  • (String) 


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

def attr_master_user_secret_secret_arn()
  jsii_get_property("attrMasterUserSecretSecretArn")
end

#attr_read_endpoint ⇒ AWSCDK::IResolvable

The ReadEndpoint return value specifies the reader endpoint for the DB cluster.

The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster. If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint. For more information about Aurora endpoints, see Amazon Aurora connection management in the Amazon Aurora User Guide.

Returns:



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

def attr_read_endpoint()
  jsii_get_property("attrReadEndpoint")
end

#attr_read_endpoint_address ⇒ String

The reader endpoint for the DB cluster.

For example: mystack-mydbcluster-ro-123456789012.us-east-2.rds.amazonaws.com

Returns:

  • (String) 


344
345
346
 
# File 'rds/cfn_db_cluster.rb', line 344

def attr_read_endpoint_address()
  jsii_get_property("attrReadEndpointAddress")
end

#attr_storage_encryption_type ⇒ String

Returns:

  • (String) 


349
350
351
 
# File 'rds/cfn_db_cluster.rb', line 349

def attr_storage_encryption_type()
  jsii_get_property("attrStorageEncryptionType")
end

#attr_storage_throughput ⇒ Numeric

The storage throughput for the DB cluster.

The throughput is automatically set based on the IOPS that you provision, and is not configurable.

This setting is only for non-Aurora Multi-AZ DB clusters.

Returns:

  • (Numeric) 


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

def attr_storage_throughput()
  jsii_get_property("attrStorageThroughput")
end

#auto_minor_version_upgrade ⇒ Boolean, ...

Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.

Returns:



405
406
407
 
# File 'rds/cfn_db_cluster.rb', line 405

def auto_minor_version_upgrade()
  jsii_get_property("autoMinorVersionUpgrade")
end

#auto_minor_version_upgrade=(value) ⇒ Object 



409
410
411
412
 
# File 'rds/cfn_db_cluster.rb', line 409

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

#availability_zones ⇒ Array<String>?

A list of Availability Zones (AZs) where instances in the DB cluster can be created.

Returns:

  • (Array<String>, nil) 


417
418
419
 
# File 'rds/cfn_db_cluster.rb', line 417

def availability_zones()
  jsii_get_property("availabilityZones")
end

#availability_zones=(value) ⇒ Object 



421
422
423
424
 
# File 'rds/cfn_db_cluster.rb', line 421

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

#backtrack_window ⇒ Numeric?

The target backtrack window, in seconds.

To disable backtracking, set this value to 0 .

Returns:

  • (Numeric, nil) 


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

def backtrack_window()
  jsii_get_property("backtrackWindow")
end

#backtrack_window=(value) ⇒ Object 



435
436
437
438
 
# File 'rds/cfn_db_cluster.rb', line 435

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

#backup_retention_period ⇒ Numeric?

The number of days for which automated backups are retained.

Returns:

  • (Numeric, nil) 


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

def backup_retention_period()
  jsii_get_property("backupRetentionPeriod")
end

#backup_retention_period=(value) ⇒ Object 



447
448
449
450
 
# File 'rds/cfn_db_cluster.rb', line 447

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:



229
230
231
 
# File 'rds/cfn_db_cluster.rb', line 229

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


234
235
236
 
# File 'rds/cfn_db_cluster.rb', line 234

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


1316
1317
1318
1319
 
# File 'rds/cfn_db_cluster.rb', line 1316

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


239
240
241
 
# File 'rds/cfn_db_cluster.rb', line 239

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


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

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#cluster_scalability_type ⇒ String?

Specifies the scalability mode of the Aurora DB cluster.

Returns:

  • (String, nil) 


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

def cluster_scalability_type()
  jsii_get_property("clusterScalabilityType")
end

#cluster_scalability_type=(value) ⇒ Object 



459
460
461
462
 
# File 'rds/cfn_db_cluster.rb', line 459

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

#copy_tags_to_snapshot ⇒ Boolean, ...

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.

Returns:



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

def copy_tags_to_snapshot()
  jsii_get_property("copyTagsToSnapshot")
end

#copy_tags_to_snapshot=(value) ⇒ Object 



471
472
473
474
 
# File 'rds/cfn_db_cluster.rb', line 471

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


191
192
193
 
# File 'rds/cfn_db_cluster.rb', line 191

def creation_stack()
  jsii_get_property("creationStack")
end

#database_insights_mode ⇒ String?

The mode of Database Insights to enable for the DB cluster.

Returns:

  • (String, nil) 


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

def database_insights_mode()
  jsii_get_property("databaseInsightsMode")
end

#database_insights_mode=(value) ⇒ Object 



483
484
485
486
 
# File 'rds/cfn_db_cluster.rb', line 483

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

#database_name ⇒ String?

The name of your database.

Returns:

  • (String, nil) 


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

def database_name()
  jsii_get_property("databaseName")
end

#database_name=(value) ⇒ Object 



495
496
497
498
 
# File 'rds/cfn_db_cluster.rb', line 495

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

#db_cluster_identifier ⇒ String?

The DB cluster identifier.

This parameter is stored as a lowercase string.

Returns:

  • (String, nil) 


505
506
507
 
# File 'rds/cfn_db_cluster.rb', line 505

def db_cluster_identifier()
  jsii_get_property("dbClusterIdentifier")
end

#db_cluster_identifier=(value) ⇒ Object 



509
510
511
512
 
# File 'rds/cfn_db_cluster.rb', line 509

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_instance_class ⇒ String?

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge . Not all DB instance classes are available in all AWS Regions , or for all database engines.

Returns:

  • (String, nil) 


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

def db_cluster_instance_class()
  jsii_get_property("dbClusterInstanceClass")
end

#db_cluster_instance_class=(value) ⇒ Object 



521
522
523
524
 
# File 'rds/cfn_db_cluster.rb', line 521

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

#db_cluster_parameter_group_name ⇒ String?

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

Returns:

  • (String, nil) 


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

def db_cluster_parameter_group_name()
  jsii_get_property("dbClusterParameterGroupName")
end

#db_cluster_parameter_group_name=(value) ⇒ Object 



533
534
535
536
 
# File 'rds/cfn_db_cluster.rb', line 533

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::AWSRDS::DBClusterReference

A reference to a DBCluster resource.

Returns:



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

def db_cluster_ref()
  jsii_get_property("dbClusterRef")
end

#db_instance_parameter_group_name ⇒ String?

The name of the DB parameter group to apply to all instances of the DB cluster.

Returns:

  • (String, nil) 


541
542
543
 
# File 'rds/cfn_db_cluster.rb', line 541

def db_instance_parameter_group_name()
  jsii_get_property("dbInstanceParameterGroupName")
end

#db_instance_parameter_group_name=(value) ⇒ Object 



545
546
547
548
 
# File 'rds/cfn_db_cluster.rb', line 545

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

#db_subnet_group_name ⇒ String?

A DB subnet group that you want to associate with this DB cluster.

Returns:

  • (String, nil) 


553
554
555
 
# File 'rds/cfn_db_cluster.rb', line 553

def db_subnet_group_name()
  jsii_get_property("dbSubnetGroupName")
end

#db_subnet_group_name=(value) ⇒ Object 



557
558
559
560
 
# File 'rds/cfn_db_cluster.rb', line 557

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

#db_system_id ⇒ String?

Reserved for future use.

Returns:

  • (String, nil) 


565
566
567
 
# File 'rds/cfn_db_cluster.rb', line 565

def db_system_id()
  jsii_get_property("dbSystemId")
end

#db_system_id=(value) ⇒ Object 



569
570
571
572
 
# File 'rds/cfn_db_cluster.rb', line 569

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

#delete_automated_backups ⇒ Boolean, ...

Specifies whether to remove automated backups immediately after the DB cluster is deleted.

Returns:



577
578
579
 
# File 'rds/cfn_db_cluster.rb', line 577

def delete_automated_backups()
  jsii_get_property("deleteAutomatedBackups")
end

#delete_automated_backups=(value) ⇒ Object 



581
582
583
584
 
# File 'rds/cfn_db_cluster.rb', line 581

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

#deletion_protection ⇒ Boolean, ...

A value that indicates whether the DB cluster has deletion protection enabled.

Returns:



589
590
591
 
# File 'rds/cfn_db_cluster.rb', line 589

def deletion_protection()
  jsii_get_property("deletionProtection")
end

#deletion_protection=(value) ⇒ Object 



593
594
595
596
 
# File 'rds/cfn_db_cluster.rb', line 593

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

#domain ⇒ String?

Indicates the directory ID of the Active Directory to create the DB cluster.

Returns:

  • (String, nil) 


601
602
603
 
# File 'rds/cfn_db_cluster.rb', line 601

def domain()
  jsii_get_property("domain")
end

#domain=(value) ⇒ Object 



605
606
607
608
 
# File 'rds/cfn_db_cluster.rb', line 605

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

#domain_iam_role_name ⇒ String?

Specifies the name of the IAM role to use when making API calls to the Directory Service.

Returns:

  • (String, nil) 


613
614
615
 
# File 'rds/cfn_db_cluster.rb', line 613

def domain_iam_role_name()
  jsii_get_property("domainIamRoleName")
end

#domain_iam_role_name=(value) ⇒ Object 



617
618
619
620
 
# File 'rds/cfn_db_cluster.rb', line 617

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

#enable_cloudwatch_logs_exports ⇒ Array<String>?

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

Returns:

  • (Array<String>, nil) 


625
626
627
 
# File 'rds/cfn_db_cluster.rb', line 625

def enable_cloudwatch_logs_exports()
  jsii_get_property("enableCloudwatchLogsExports")
end

#enable_cloudwatch_logs_exports=(value) ⇒ Object 



629
630
631
632
 
# File 'rds/cfn_db_cluster.rb', line 629

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

#enable_global_write_forwarding ⇒ Boolean, ...

Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database).

Returns:



637
638
639
 
# File 'rds/cfn_db_cluster.rb', line 637

def enable_global_write_forwarding()
  jsii_get_property("enableGlobalWriteForwarding")
end

#enable_global_write_forwarding=(value) ⇒ Object 



641
642
643
644
 
# File 'rds/cfn_db_cluster.rb', line 641

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

#enable_http_endpoint ⇒ Boolean, ...

Specifies whether to enable the HTTP endpoint for the DB cluster.

By default, the HTTP endpoint isn't enabled.

Returns:



651
652
653
 
# File 'rds/cfn_db_cluster.rb', line 651

def enable_http_endpoint()
  jsii_get_property("enableHttpEndpoint")
end

#enable_http_endpoint=(value) ⇒ Object 



655
656
657
658
 
# File 'rds/cfn_db_cluster.rb', line 655

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

#enable_iam_database_authentication ⇒ Boolean, ...

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.

Returns:



663
664
665
 
# File 'rds/cfn_db_cluster.rb', line 663

def enable_iam_database_authentication()
  jsii_get_property("enableIamDatabaseAuthentication")
end

#enable_iam_database_authentication=(value) ⇒ Object 



667
668
669
670
 
# File 'rds/cfn_db_cluster.rb', line 667

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

#enable_local_write_forwarding ⇒ Boolean, ...

Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster.

Returns:



675
676
677
 
# File 'rds/cfn_db_cluster.rb', line 675

def enable_local_write_forwarding()
  jsii_get_property("enableLocalWriteForwarding")
end

#enable_local_write_forwarding=(value) ⇒ Object 



679
680
681
682
 
# File 'rds/cfn_db_cluster.rb', line 679

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

#engine ⇒ String?

The name of the database engine to be used for this DB cluster.

Returns:

  • (String, nil) 


687
688
689
 
# File 'rds/cfn_db_cluster.rb', line 687

def engine()
  jsii_get_property("engine")
end

#engine=(value) ⇒ Object 



691
692
693
694
 
# File 'rds/cfn_db_cluster.rb', line 691

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_lifecycle_support ⇒ String?

The life cycle type for this DB cluster.

Returns:

  • (String, nil) 


699
700
701
 
# File 'rds/cfn_db_cluster.rb', line 699

def engine_lifecycle_support()
  jsii_get_property("engineLifecycleSupport")
end

#engine_lifecycle_support=(value) ⇒ Object 



703
704
705
706
 
# File 'rds/cfn_db_cluster.rb', line 703

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

#engine_mode ⇒ String?

The DB engine mode of the DB cluster, either provisioned or serverless .

Returns:

  • (String, nil) 


711
712
713
 
# File 'rds/cfn_db_cluster.rb', line 711

def engine_mode()
  jsii_get_property("engineMode")
end

#engine_mode=(value) ⇒ Object 



715
716
717
718
 
# File 'rds/cfn_db_cluster.rb', line 715

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

#engine_version ⇒ String?

The version number of the database engine to use.

Returns:

  • (String, nil) 


723
724
725
 
# File 'rds/cfn_db_cluster.rb', line 723

def engine_version()
  jsii_get_property("engineVersion")
end

#engine_version=(value) ⇒ Object 



727
728
729
730
 
# File 'rds/cfn_db_cluster.rb', line 727

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:



251
252
253
 
# File 'rds/cfn_db_cluster.rb', line 251

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:



1329
1330
1331
1332
1333
 
# File 'rds/cfn_db_cluster.rb', line 1329

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:



1340
1341
1342
1343
 
# File 'rds/cfn_db_cluster.rb', line 1340

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?

If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster.

Returns:

  • (String, nil) 


735
736
737
 
# File 'rds/cfn_db_cluster.rb', line 735

def global_cluster_identifier()
  jsii_get_property("globalClusterIdentifier")
end

#global_cluster_identifier=(value) ⇒ Object 



739
740
741
742
 
# File 'rds/cfn_db_cluster.rb', line 739

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:



1410
1411
1412
1413
 
# File 'rds/cfn_db_cluster.rb', line 1410

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

#iops ⇒ Numeric?

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

Returns:

  • (Numeric, nil) 


747
748
749
 
# File 'rds/cfn_db_cluster.rb', line 747

def iops()
  jsii_get_property("iops")
end

#iops=(value) ⇒ Object 



751
752
753
754
 
# File 'rds/cfn_db_cluster.rb', line 751

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

#kms_key_id ⇒ String?

The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef .

Returns:

  • (String, nil) 


759
760
761
 
# File 'rds/cfn_db_cluster.rb', line 759

def kms_key_id()
  jsii_get_property("kmsKeyId")
end

#kms_key_id=(value) ⇒ Object 



763
764
765
766
 
# File 'rds/cfn_db_cluster.rb', line 763

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) 


203
204
205
 
# File 'rds/cfn_db_cluster.rb', line 203

def logical_id()
  jsii_get_property("logicalId")
end

#manage_master_user_password ⇒ Boolean, ...

Specifies whether to manage the master user password with AWS Secrets Manager.

Returns:



771
772
773
 
# File 'rds/cfn_db_cluster.rb', line 771

def manage_master_user_password()
  jsii_get_property("manageMasterUserPassword")
end

#manage_master_user_password=(value) ⇒ Object 



775
776
777
778
 
# File 'rds/cfn_db_cluster.rb', line 775

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_authentication_type ⇒ String?

Specifies the authentication type for the master user.

Returns:

  • (String, nil) 


783
784
785
 
# File 'rds/cfn_db_cluster.rb', line 783

def master_user_authentication_type()
  jsii_get_property("masterUserAuthenticationType")
end

#master_user_authentication_type=(value) ⇒ Object 



787
788
789
790
 
# File 'rds/cfn_db_cluster.rb', line 787

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

#master_user_password ⇒ String?

The master password for the DB instance.

Returns:

  • (String, nil) 


807
808
809
 
# File 'rds/cfn_db_cluster.rb', line 807

def master_user_password()
  jsii_get_property("masterUserPassword")
end

#master_user_password=(value) ⇒ Object 



811
812
813
814
 
# File 'rds/cfn_db_cluster.rb', line 811

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 ⇒ AWSCDK::IResolvable, ...

The secret managed by RDS in AWS Secrets Manager for the master user password.

Returns:



819
820
821
 
# File 'rds/cfn_db_cluster.rb', line 819

def master_user_secret()
  jsii_get_property("masterUserSecret")
end

#master_user_secret=(value) ⇒ Object 



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

def master_user_secret=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::RDS::CfnDBCluster::MasterUserSecretProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19yZHMuQ2ZuREJDbHVzdGVyLk1hc3RlclVzZXJTZWNyZXRQcm9wZXJ0eSJ9XX19")), "masterUserSecret") unless value.nil?
  jsii_set_property("masterUserSecret", value)
end

#master_username ⇒ String?

The name of the master user for the DB cluster.

Returns:

  • (String, nil) 


795
796
797
 
# File 'rds/cfn_db_cluster.rb', line 795

def master_username()
  jsii_get_property("masterUsername")
end

#master_username=(value) ⇒ Object 



799
800
801
802
 
# File 'rds/cfn_db_cluster.rb', line 799

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

#monitoring_interval ⇒ Numeric?

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.

Returns:

  • (Numeric, nil) 


832
833
834
 
# File 'rds/cfn_db_cluster.rb', line 832

def monitoring_interval()
  jsii_get_property("monitoringInterval")
end

#monitoring_interval=(value) ⇒ Object 



836
837
838
839
 
# File 'rds/cfn_db_cluster.rb', line 836

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

#monitoring_role_arn ⇒ String?

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

Returns:

  • (String, nil) 


844
845
846
 
# File 'rds/cfn_db_cluster.rb', line 844

def monitoring_role_arn()
  jsii_get_property("monitoringRoleArn")
end

#monitoring_role_arn=(value) ⇒ Object 



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

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

#network_type ⇒ String?

The network type of the DB cluster.

Returns:

  • (String, nil) 


856
857
858
 
# File 'rds/cfn_db_cluster.rb', line 856

def network_type()
  jsii_get_property("networkType")
end

#network_type=(value) ⇒ Object 



860
861
862
863
 
# File 'rds/cfn_db_cluster.rb', line 860

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) 


186
187
188
 
# File 'rds/cfn_db_cluster.rb', line 186

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:



1351
1352
1353
 
# File 'rds/cfn_db_cluster.rb', line 1351

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:



1358
1359
1360
 
# File 'rds/cfn_db_cluster.rb', line 1358

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.



1151
1152
1153
1154
 
# File 'rds/cfn_db_cluster.rb', line 1151

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

#performance_insights_enabled ⇒ Boolean, ...

Specifies whether to turn on Performance Insights for the DB cluster.

Returns:



868
869
870
 
# File 'rds/cfn_db_cluster.rb', line 868

def performance_insights_enabled()
  jsii_get_property("performanceInsightsEnabled")
end

#performance_insights_enabled=(value) ⇒ Object 



872
873
874
875
 
# File 'rds/cfn_db_cluster.rb', line 872

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

#performance_insights_kms_key_id ⇒ String?

The AWS KMS key identifier for encryption of Performance Insights data.

Returns:

  • (String, nil) 


880
881
882
 
# File 'rds/cfn_db_cluster.rb', line 880

def performance_insights_kms_key_id()
  jsii_get_property("performanceInsightsKmsKeyId")
end

#performance_insights_kms_key_id=(value) ⇒ Object 



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

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

#performance_insights_retention_period ⇒ Numeric?

The number of days to retain Performance Insights data.

Returns:

  • (Numeric, nil) 


892
893
894
 
# File 'rds/cfn_db_cluster.rb', line 892

def performance_insights_retention_period()
  jsii_get_property("performanceInsightsRetentionPeriod")
end

#performance_insights_retention_period=(value) ⇒ Object 



896
897
898
899
 
# File 'rds/cfn_db_cluster.rb', line 896

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

#port ⇒ Numeric?

The port number on which the DB instances in the DB cluster accept connections.

Returns:

  • (Numeric, nil) 


904
905
906
 
# File 'rds/cfn_db_cluster.rb', line 904

def port()
  jsii_get_property("port")
end

#port=(value) ⇒ Object 



908
909
910
911
 
# File 'rds/cfn_db_cluster.rb', line 908

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.

Returns:

  • (String, nil) 


916
917
918
 
# File 'rds/cfn_db_cluster.rb', line 916

def preferred_backup_window()
  jsii_get_property("preferredBackupWindow")
end

#preferred_backup_window=(value) ⇒ Object 



920
921
922
923
 
# File 'rds/cfn_db_cluster.rb', line 920

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) 


928
929
930
 
# File 'rds/cfn_db_cluster.rb', line 928

def preferred_maintenance_window()
  jsii_get_property("preferredMaintenanceWindow")
end

#preferred_maintenance_window=(value) ⇒ Object 



932
933
934
935
 
# File 'rds/cfn_db_cluster.rb', line 932

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

#publicly_accessible ⇒ Boolean, ...

Specifies whether the DB cluster is publicly accessible.

Returns:



940
941
942
 
# File 'rds/cfn_db_cluster.rb', line 940

def publicly_accessible()
  jsii_get_property("publiclyAccessible")
end

#publicly_accessible=(value) ⇒ Object 



944
945
946
947
 
# File 'rds/cfn_db_cluster.rb', line 944

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


222
223
224
 
# File 'rds/cfn_db_cluster.rb', line 222

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:



1369
1370
1371
1372
 
# File 'rds/cfn_db_cluster.rb', line 1369

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


1376
1377
1378
1379
 
# File 'rds/cfn_db_cluster.rb', line 1376

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:



1386
1387
1388
1389
1390
 
# File 'rds/cfn_db_cluster.rb', line 1386

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

#replication_source_identifier ⇒ String?

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.

Returns:

  • (String, nil) 


952
953
954
 
# File 'rds/cfn_db_cluster.rb', line 952

def replication_source_identifier()
  jsii_get_property("replicationSourceIdentifier")
end

#replication_source_identifier=(value) ⇒ Object 



956
957
958
959
 
# File 'rds/cfn_db_cluster.rb', line 956

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

#restore_to_time ⇒ String?

The date and time to restore the DB cluster to.

Returns:

  • (String, nil) 


964
965
966
 
# File 'rds/cfn_db_cluster.rb', line 964

def restore_to_time()
  jsii_get_property("restoreToTime")
end

#restore_to_time=(value) ⇒ Object 



968
969
970
971
 
# File 'rds/cfn_db_cluster.rb', line 968

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) 


978
979
980
 
# File 'rds/cfn_db_cluster.rb', line 978

def restore_type()
  jsii_get_property("restoreType")
end

#restore_type=(value) ⇒ Object 



982
983
984
985
 
# File 'rds/cfn_db_cluster.rb', line 982

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

#scaling_configuration ⇒ AWSCDK::IResolvable, ...

The scaling configuration of an Aurora Serverless v1 DB cluster.

Returns:



990
991
992
 
# File 'rds/cfn_db_cluster.rb', line 990

def scaling_configuration()
  jsii_get_property("scalingConfiguration")
end

#scaling_configuration=(value) ⇒ Object 



994
995
996
997
998
 
# File 'rds/cfn_db_cluster.rb', line 994

def scaling_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::RDS::CfnDBCluster::ScalingConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19yZHMuQ2ZuREJDbHVzdGVyLlNjYWxpbmdDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "scalingConfiguration") unless value.nil?
  jsii_set_property("scalingConfiguration", value)
end

#serverless_v2_scaling_configuration ⇒ AWSCDK::IResolvable, ...

The scaling configuration of an Aurora Serverless V2 DB cluster.

Returns:



1003
1004
1005
 
# File 'rds/cfn_db_cluster.rb', line 1003

def serverless_v2_scaling_configuration()
  jsii_get_property("serverlessV2ScalingConfiguration")
end

#serverless_v2_scaling_configuration=(value) ⇒ Object 



1007
1008
1009
1010
1011
 
# File 'rds/cfn_db_cluster.rb', line 1007

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



1395
1396
1397
 
# File 'rds/cfn_db_cluster.rb', line 1395

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

#snapshot_identifier ⇒ String?

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

Returns:

  • (String, nil) 


1016
1017
1018
 
# File 'rds/cfn_db_cluster.rb', line 1016

def snapshot_identifier()
  jsii_get_property("snapshotIdentifier")
end

#snapshot_identifier=(value) ⇒ Object 



1020
1021
1022
1023
 
# File 'rds/cfn_db_cluster.rb', line 1020

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?

When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore.

Returns:

  • (String, nil) 


1028
1029
1030
 
# File 'rds/cfn_db_cluster.rb', line 1028

def source_db_cluster_identifier()
  jsii_get_property("sourceDbClusterIdentifier")
end

#source_db_cluster_identifier=(value) ⇒ Object 



1032
1033
1034
1035
 
# File 'rds/cfn_db_cluster.rb', line 1032

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

#source_db_cluster_resource_id ⇒ String?

The resource ID of the source DB cluster from which to restore.

Returns:

  • (String, nil) 


1040
1041
1042
 
# File 'rds/cfn_db_cluster.rb', line 1040

def source_db_cluster_resource_id()
  jsii_get_property("sourceDbClusterResourceId")
end

#source_db_cluster_resource_id=(value) ⇒ Object 



1044
1045
1046
1047
 
# File 'rds/cfn_db_cluster.rb', line 1044

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

#source_region ⇒ String?

The AWS Region which contains the source DB cluster when replicating a DB cluster.

For example, us-east-1 .

Returns:

  • (String, nil) 


1054
1055
1056
 
# File 'rds/cfn_db_cluster.rb', line 1054

def source_region()
  jsii_get_property("sourceRegion")
end

#source_region=(value) ⇒ Object 



1058
1059
1060
1061
 
# File 'rds/cfn_db_cluster.rb', line 1058

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



212
213
214
 
# File 'rds/cfn_db_cluster.rb', line 212

def stack()
  jsii_get_property("stack")
end

#storage_encrypted ⇒ Boolean, ...

Indicates whether the DB cluster is encrypted.

Returns:



1066
1067
1068
 
# File 'rds/cfn_db_cluster.rb', line 1066

def storage_encrypted()
  jsii_get_property("storageEncrypted")
end

#storage_encrypted=(value) ⇒ Object 



1070
1071
1072
1073
 
# File 'rds/cfn_db_cluster.rb', line 1070

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) 


1078
1079
1080
 
# File 'rds/cfn_db_cluster.rb', line 1078

def storage_type()
  jsii_get_property("storageType")
end

#storage_type=(value) ⇒ Object 



1082
1083
1084
1085
 
# File 'rds/cfn_db_cluster.rb', line 1082

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:



374
375
376
 
# File 'rds/cfn_db_cluster.rb', line 374

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

Tags to assign to the DB cluster.

Returns:



1090
1091
1092
 
# File 'rds/cfn_db_cluster.rb', line 1090

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



1094
1095
1096
1097
1098
 
# File 'rds/cfn_db_cluster.rb', line 1094

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



1127
1128
1129
 
# File 'rds/cfn_db_cluster.rb', line 1127

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


259
260
261
 
# File 'rds/cfn_db_cluster.rb', line 259

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


269
270
271
 
# File 'rds/cfn_db_cluster.rb', line 269

def updated_properties()
  jsii_get_property("updatedProperties")
end

#use_latest_restorable_time ⇒ Boolean, ...

A value that indicates whether to restore the DB cluster to the latest restorable backup time.

Returns:



1103
1104
1105
 
# File 'rds/cfn_db_cluster.rb', line 1103

def use_latest_restorable_time()
  jsii_get_property("useLatestRestorableTime")
end

#use_latest_restorable_time=(value) ⇒ Object 



1107
1108
1109
1110
 
# File 'rds/cfn_db_cluster.rb', line 1107

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) 


1401
1402
1403
1404
 
# File 'rds/cfn_db_cluster.rb', line 1401

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 DB cluster.

Returns:

  • (Array<String>, nil) 


1115
1116
1117
 
# File 'rds/cfn_db_cluster.rb', line 1115

def vpc_security_group_ids()
  jsii_get_property("vpcSecurityGroupIds")
end

#vpc_security_group_ids=(value) ⇒ Object 



1119
1120
1121
1122
 
# File 'rds/cfn_db_cluster.rb', line 1119

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) 


1140
1141
1142
1143
1144
1145
 
# File 'rds/cfn_db_cluster.rb', line 1140

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