Class: AWSCDK::DocDB::DatabaseCluster

Inherits:
Resource
  • Object
show all
Includes:
IDatabaseCluster
Defined in:
doc_db/database_cluster.rb

Overview

Create a clustered database with a given number of instances.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ DatabaseCluster

Returns a new instance of DatabaseCluster.

Parameters:



12
13
14
15
16
17
18
 
# File 'doc_db/database_cluster.rb', line 12

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

Class Method Details

.DEFAULT_NUM_INSTANCES ⇒ Numeric

The default number of instances in the DocDB cluster if none are specified.

Returns:

  • (Numeric) 


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

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

.DEFAULT_PORT ⇒ Numeric

The default port Document DB listens on.

Returns:

  • (Numeric) 


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

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

.from_database_cluster_attributes(scope, id, attrs) ⇒ AWSCDK::DocDB::IDatabaseCluster

Import an existing DatabaseCluster from properties.

Parameters:

Returns:



56
57
58
59
60
61
62
 
# File 'doc_db/database_cluster.rb', line 56

def self.from_database_cluster_attributes(scope, id, attrs)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  attrs = attrs.is_a?(Hash) ? ::AWSCDK::DocDB::DatabaseClusterAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZG9jZGIuRGF0YWJhc2VDbHVzdGVyQXR0cmlidXRlcyJ9")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_docdb.DatabaseCluster", "fromDatabaseClusterAttributes", [scope, id, attrs])
end

.jsii_overridable_methods ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'doc_db/database_cluster.rb', line 20

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :cluster_endpoint => { kind: :property, name: "clusterEndpoint", is_optional: false },
    :cluster_identifier => { kind: :property, name: "clusterIdentifier", is_optional: false },
    :cluster_read_endpoint => { kind: :property, name: "clusterReadEndpoint", is_optional: false },
    :cluster_resource_identifier => { kind: :property, name: "clusterResourceIdentifier", is_optional: false },
    :connections => { kind: :property, name: "connections", is_optional: false },
    :db_cluster_ref => { kind: :property, name: "dbClusterRef", is_optional: false },
    :instance_endpoints => { kind: :property, name: "instanceEndpoints", is_optional: false },
    :instance_identifiers => { kind: :property, name: "instanceIdentifiers", is_optional: false },
    :security_group_id => { kind: :property, name: "securityGroupId", is_optional: false },
    :secret => { kind: :property, name: "secret", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", 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 },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :add_rotation_multi_user => { kind: :method, name: "addRotationMultiUser", is_optional: false },
    :add_rotation_single_user => { kind: :method, name: "addRotationSingleUser", is_optional: false },
    :add_security_groups => { kind: :method, name: "addSecurityGroups", is_optional: false },
    :as_secret_attachment_target => { kind: :method, name: "asSecretAttachmentTarget", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


124
125
126
 
# File 'doc_db/database_cluster.rb', line 124

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

Instance Method Details

#add_rotation_multi_user(id, options) ⇒ AWSCDK::SecretsManager::SecretRotation

Adds the multi user rotation to this cluster.

Parameters:

Returns:



296
297
298
299
300
301
 
# File 'doc_db/database_cluster.rb', line 296

def add_rotation_multi_user(id, options)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  options = options.is_a?(Hash) ? ::AWSCDK::DocDB::RotationMultiUserOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZG9jZGIuUm90YXRpb25NdWx0aVVzZXJPcHRpb25zIn0=")), "options")
  jsii_call_method("addRotationMultiUser", [id, options])
end

#add_rotation_single_user(automatically_after = nil) ⇒ AWSCDK::SecretsManager::SecretRotation

Adds the single user rotation of the master password to this cluster.

Parameters:

  • automatically_after (AWSCDK::Duration, nil) (defaults to: nil) —

    Specifies the number of days after the previous rotation before Secrets Manager triggers the next automatic rotation.

Returns:



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

def add_rotation_single_user(automatically_after = nil)
  Jsii::Type.check_type(automatically_after, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5EdXJhdGlvbiJ9")), "automaticallyAfter") unless automatically_after.nil?
  jsii_call_method("addRotationSingleUser", [automatically_after])
end

#add_security_groups(*security_groups) ⇒ void

This method returns an undefined value.

Adds security groups to this cluster.

Parameters:



316
317
318
319
320
321
 
# File 'doc_db/database_cluster.rb', line 316

def add_security_groups(*security_groups)
  security_groups.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLklTZWN1cml0eUdyb3VwIn0=")), "securityGroups[#{index}]")
  end
  jsii_call_method("addSecurityGroups", [*security_groups])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



234
235
236
237
 
# File 'doc_db/database_cluster.rb', line 234

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

This method returns an undefined value.

Apply the given removal policy to this resource.

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

Parameters:



251
252
253
254
 
# File 'doc_db/database_cluster.rb', line 251

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#as_secret_attachment_target ⇒ AWSCDK::SecretsManager::SecretAttachmentTargetProps

Renders the secret attachment target specifications.

Returns:



326
327
328
 
# File 'doc_db/database_cluster.rb', line 326

def as_secret_attachment_target()
  jsii_call_method("asSecretAttachmentTarget", [])
end

#cluster_endpoint ⇒ AWSCDK::DocDB::Endpoint

The endpoint to use for read/write operations.

Returns:



131
132
133
 
# File 'doc_db/database_cluster.rb', line 131

def cluster_endpoint()
  jsii_get_property("clusterEndpoint")
end

#cluster_identifier ⇒ String

Identifier of the cluster.

Returns:

  • (String) 


138
139
140
 
# File 'doc_db/database_cluster.rb', line 138

def cluster_identifier()
  jsii_get_property("clusterIdentifier")
end

#cluster_read_endpoint ⇒ AWSCDK::DocDB::Endpoint

Endpoint to use for load-balanced read-only operations.

Returns:



145
146
147
 
# File 'doc_db/database_cluster.rb', line 145

def cluster_read_endpoint()
  jsii_get_property("clusterReadEndpoint")
end

#cluster_resource_identifier ⇒ 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) 


155
156
157
 
# File 'doc_db/database_cluster.rb', line 155

def cluster_resource_identifier()
  jsii_get_property("clusterResourceIdentifier")
end

#connections ⇒ AWSCDK::EC2::Connections

The connections object to implement IConnectable.

Returns:



162
163
164
 
# File 'doc_db/database_cluster.rb', line 162

def connections()
  jsii_get_property("connections")
end

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

A reference to this cluster.

Returns:



169
170
171
 
# File 'doc_db/database_cluster.rb', line 169

def db_cluster_ref()
  jsii_get_property("dbClusterRef")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



82
83
84
 
# File 'doc_db/database_cluster.rb', line 82

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


257
258
259
 
# File 'doc_db/database_cluster.rb', line 257

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


271
272
273
274
275
276
 
# File 'doc_db/database_cluster.rb', line 271

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


286
287
288
289
 
# File 'doc_db/database_cluster.rb', line 286

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#instance_endpoints ⇒ Array<AWSCDK::DocDB::Endpoint>

Endpoints which address each individual replica.

Returns:



176
177
178
 
# File 'doc_db/database_cluster.rb', line 176

def instance_endpoints()
  jsii_get_property("instanceEndpoints")
end

#instance_identifiers ⇒ Array<String>

Identifiers of the replicas.

Returns:

  • (Array<String>) 


183
184
185
 
# File 'doc_db/database_cluster.rb', line 183

def instance_identifiers()
  jsii_get_property("instanceIdentifiers")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


67
68
69
 
# File 'doc_db/database_cluster.rb', line 67

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


96
97
98
 
# File 'doc_db/database_cluster.rb', line 96

def physical_name()
  jsii_get_property("physicalName")
end

#secret ⇒ AWSCDK::SecretsManager::ISecret?

The secret attached to this cluster.

Returns:



197
198
199
 
# File 'doc_db/database_cluster.rb', line 197

def secret()
  jsii_get_property("secret")
end

#security_group_id ⇒ String

Security group identifier of this database.

Returns:

  • (String) 


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

def security_group_id()
  jsii_get_property("securityGroupId")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



103
104
105
 
# File 'doc_db/database_cluster.rb', line 103

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


204
205
206
 
# File 'doc_db/database_cluster.rb', line 204

def to_string()
  jsii_call_method("toString", [])
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) 


217
218
219
220
221
222
 
# File 'doc_db/database_cluster.rb', line 217

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