Class: AWSCDK::DocDBElastic::CfnCluster

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSDocdbelastic::IClusterRef
Defined in:
doc_db_elastic/cfn_cluster.rb

Overview

Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnCluster

Create a new AWS::DocDBElastic::Cluster.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::DocDBElastic::CfnClusterProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'doc_db_elastic/cfn_cluster.rb', line 18

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

Class Method Details

.arn_for_cluster(resource) ⇒ String

Parameters:

Returns:

  • (String) 


86
87
88
89
 
# File 'doc_db_elastic/cfn_cluster.rb', line 86

def self.arn_for_cluster(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19kb2NkYmVsYXN0aWMuSUNsdXN0ZXJSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_docdbelastic.CfnCluster", "arnForCluster", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


193
194
195
 
# File 'doc_db_elastic/cfn_cluster.rb', line 193

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

.is_cfn_cluster(x) ⇒ Boolean

Checks whether the given object is a CfnCluster.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


95
96
97
98
 
# File 'doc_db_elastic/cfn_cluster.rb', line 95

def self.is_cfn_cluster(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_docdbelastic.CfnCluster", "isCfnCluster", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'doc_db_elastic/cfn_cluster.rb', line 26

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_cluster_arn => { kind: :property, name: "attrClusterArn", is_optional: false },
    :attr_cluster_endpoint => { kind: :property, name: "attrClusterEndpoint", is_optional: false },
    :cluster_ref => { kind: :property, name: "clusterRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :admin_user_name => { kind: :property, name: "adminUserName", is_optional: false },
    :auth_type => { kind: :property, name: "authType", is_optional: false },
    :cluster_name => { kind: :property, name: "clusterName", is_optional: false },
    :shard_capacity => { kind: :property, name: "shardCapacity", is_optional: false },
    :shard_count => { kind: :property, name: "shardCount", is_optional: false },
    :admin_user_password => { kind: :property, name: "adminUserPassword", is_optional: true },
    :backup_retention_period => { kind: :property, name: "backupRetentionPeriod", is_optional: true },
    :kms_key_id => { kind: :property, name: "kmsKeyId", is_optional: true },
    :preferred_backup_window => { kind: :property, name: "preferredBackupWindow", is_optional: true },
    :preferred_maintenance_window => { kind: :property, name: "preferredMaintenanceWindow", is_optional: true },
    :shard_instance_count => { kind: :property, name: "shardInstanceCount", is_optional: true },
    :subnet_ids => { kind: :property, name: "subnetIds", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", 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.



430
431
432
433
 
# File 'doc_db_elastic/cfn_cluster.rb', line 430

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:



442
443
444
445
 
# File 'doc_db_elastic/cfn_cluster.rb', line 442

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:



452
453
454
455
 
# File 'doc_db_elastic/cfn_cluster.rb', line 452

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:



463
464
465
466
467
 
# File 'doc_db_elastic/cfn_cluster.rb', line 463

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.


520
521
522
523
524
 
# File 'doc_db_elastic/cfn_cluster.rb', line 520

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.



530
531
532
533
 
# File 'doc_db_elastic/cfn_cluster.rb', line 530

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.



542
543
544
545
546
 
# File 'doc_db_elastic/cfn_cluster.rb', line 542

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

#admin_user_name ⇒ String

The name of the Amazon DocumentDB elastic clusters administrator.

Returns:

  • (String) 


226
227
228
 
# File 'doc_db_elastic/cfn_cluster.rb', line 226

def admin_user_name()
  jsii_get_property("adminUserName")
end

#admin_user_name=(value) ⇒ Object 



230
231
232
233
 
# File 'doc_db_elastic/cfn_cluster.rb', line 230

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

#admin_user_password ⇒ String?

The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters.

Returns:

  • (String, nil) 


288
289
290
 
# File 'doc_db_elastic/cfn_cluster.rb', line 288

def admin_user_password()
  jsii_get_property("adminUserPassword")
end

#admin_user_password=(value) ⇒ Object 



292
293
294
295
 
# File 'doc_db_elastic/cfn_cluster.rb', line 292

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



555
556
557
558
 
# File 'doc_db_elastic/cfn_cluster.rb', line 555

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:



577
578
579
580
581
582
 
# File 'doc_db_elastic/cfn_cluster.rb', line 577

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_cluster_arn ⇒ String

Returns:

  • (String) 


198
199
200
 
# File 'doc_db_elastic/cfn_cluster.rb', line 198

def attr_cluster_arn()
  jsii_get_property("attrClusterArn")
end

#attr_cluster_endpoint ⇒ String

The URL used to connect to the elastic cluster.

Returns:

  • (String) 


205
206
207
 
# File 'doc_db_elastic/cfn_cluster.rb', line 205

def attr_cluster_endpoint()
  jsii_get_property("attrClusterEndpoint")
end

#auth_type ⇒ String

The authentication type used to determine where to fetch the password used for accessing the elastic cluster.

Returns:

  • (String) 


238
239
240
 
# File 'doc_db_elastic/cfn_cluster.rb', line 238

def auth_type()
  jsii_get_property("authType")
end

#auth_type=(value) ⇒ Object 



242
243
244
245
 
# File 'doc_db_elastic/cfn_cluster.rb', line 242

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

#backup_retention_period ⇒ Numeric?

The number of days for which automatic snapshots are retained.

Returns:

  • (Numeric, nil) 


300
301
302
 
# File 'doc_db_elastic/cfn_cluster.rb', line 300

def backup_retention_period()
  jsii_get_property("backupRetentionPeriod")
end

#backup_retention_period=(value) ⇒ Object 



304
305
306
307
 
# File 'doc_db_elastic/cfn_cluster.rb', line 304

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:



146
147
148
 
# File 'doc_db_elastic/cfn_cluster.rb', line 146

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


151
152
153
 
# File 'doc_db_elastic/cfn_cluster.rb', line 151

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


586
587
588
589
 
# File 'doc_db_elastic/cfn_cluster.rb', line 586

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


156
157
158
 
# File 'doc_db_elastic/cfn_cluster.rb', line 156

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


163
164
165
 
# File 'doc_db_elastic/cfn_cluster.rb', line 163

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#cluster_name ⇒ String

The name of the new elastic cluster.

This parameter is stored as a lowercase string.

Returns:

  • (String) 


252
253
254
 
# File 'doc_db_elastic/cfn_cluster.rb', line 252

def cluster_name()
  jsii_get_property("clusterName")
end

#cluster_name=(value) ⇒ Object 



256
257
258
259
 
# File 'doc_db_elastic/cfn_cluster.rb', line 256

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

#cluster_ref ⇒ AWSCDK::Interfaces::AWSDocdbelastic::ClusterReference

A reference to a Cluster resource.

Returns:



212
213
214
 
# File 'doc_db_elastic/cfn_cluster.rb', line 212

def cluster_ref()
  jsii_get_property("clusterRef")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


108
109
110
 
# File 'doc_db_elastic/cfn_cluster.rb', line 108

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



168
169
170
 
# File 'doc_db_elastic/cfn_cluster.rb', line 168

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:



599
600
601
602
603
 
# File 'doc_db_elastic/cfn_cluster.rb', line 599

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:



610
611
612
613
 
# File 'doc_db_elastic/cfn_cluster.rb', line 610

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



680
681
682
683
 
# File 'doc_db_elastic/cfn_cluster.rb', line 680

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

#kms_key_id ⇒ String?

The KMS key identifier to use to encrypt the new elastic cluster.

Returns:

  • (String, nil) 


312
313
314
 
# File 'doc_db_elastic/cfn_cluster.rb', line 312

def kms_key_id()
  jsii_get_property("kmsKeyId")
end

#kms_key_id=(value) ⇒ Object 



316
317
318
319
 
# File 'doc_db_elastic/cfn_cluster.rb', line 316

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) 


120
121
122
 
# File 'doc_db_elastic/cfn_cluster.rb', line 120

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


103
104
105
 
# File 'doc_db_elastic/cfn_cluster.rb', line 103

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:



621
622
623
 
# File 'doc_db_elastic/cfn_cluster.rb', line 621

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:



628
629
630
 
# File 'doc_db_elastic/cfn_cluster.rb', line 628

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.



421
422
423
424
 
# File 'doc_db_elastic/cfn_cluster.rb', line 421

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

#preferred_backup_window ⇒ String?

The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod .

Returns:

  • (String, nil) 


324
325
326
 
# File 'doc_db_elastic/cfn_cluster.rb', line 324

def preferred_backup_window()
  jsii_get_property("preferredBackupWindow")
end

#preferred_backup_window=(value) ⇒ Object 



328
329
330
331
 
# File 'doc_db_elastic/cfn_cluster.rb', line 328

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) 


336
337
338
 
# File 'doc_db_elastic/cfn_cluster.rb', line 336

def preferred_maintenance_window()
  jsii_get_property("preferredMaintenanceWindow")
end

#preferred_maintenance_window=(value) ⇒ Object 



340
341
342
343
 
# File 'doc_db_elastic/cfn_cluster.rb', line 340

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

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


139
140
141
 
# File 'doc_db_elastic/cfn_cluster.rb', line 139

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:



639
640
641
642
 
# File 'doc_db_elastic/cfn_cluster.rb', line 639

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


646
647
648
649
 
# File 'doc_db_elastic/cfn_cluster.rb', line 646

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:



656
657
658
659
660
 
# File 'doc_db_elastic/cfn_cluster.rb', line 656

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

#shard_capacity ⇒ Numeric

The number of vCPUs assigned to each elastic cluster shard.

Returns:

  • (Numeric) 


264
265
266
 
# File 'doc_db_elastic/cfn_cluster.rb', line 264

def shard_capacity()
  jsii_get_property("shardCapacity")
end

#shard_capacity=(value) ⇒ Object 



268
269
270
271
 
# File 'doc_db_elastic/cfn_cluster.rb', line 268

def shard_capacity=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "shardCapacity")
  jsii_set_property("shardCapacity", value)
end

#shard_count ⇒ Numeric

The number of shards assigned to the elastic cluster.

Returns:

  • (Numeric) 


276
277
278
 
# File 'doc_db_elastic/cfn_cluster.rb', line 276

def shard_count()
  jsii_get_property("shardCount")
end

#shard_count=(value) ⇒ Object 



280
281
282
283
 
# File 'doc_db_elastic/cfn_cluster.rb', line 280

def shard_count=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "shardCount")
  jsii_set_property("shardCount", value)
end

#shard_instance_count ⇒ Numeric?

The number of replica instances applying to all shards in the cluster.

Returns:

  • (Numeric, nil) 


348
349
350
 
# File 'doc_db_elastic/cfn_cluster.rb', line 348

def shard_instance_count()
  jsii_get_property("shardInstanceCount")
end

#shard_instance_count=(value) ⇒ Object 



352
353
354
355
 
# File 'doc_db_elastic/cfn_cluster.rb', line 352

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



665
666
667
 
# File 'doc_db_elastic/cfn_cluster.rb', line 665

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

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



129
130
131
 
# File 'doc_db_elastic/cfn_cluster.rb', line 129

def stack()
  jsii_get_property("stack")
end

#subnet_ids ⇒ Array<String>?

The Amazon EC2 subnet IDs for the new elastic cluster.

Returns:

  • (Array<String>, nil) 


360
361
362
 
# File 'doc_db_elastic/cfn_cluster.rb', line 360

def subnet_ids()
  jsii_get_property("subnetIds")
end

#subnet_ids=(value) ⇒ Object 



364
365
366
367
 
# File 'doc_db_elastic/cfn_cluster.rb', line 364

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

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



219
220
221
 
# File 'doc_db_elastic/cfn_cluster.rb', line 219

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

The tags to be assigned to the new elastic cluster.

Returns:



372
373
374
 
# File 'doc_db_elastic/cfn_cluster.rb', line 372

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



376
377
378
379
380
 
# File 'doc_db_elastic/cfn_cluster.rb', line 376

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



397
398
399
 
# File 'doc_db_elastic/cfn_cluster.rb', line 397

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


176
177
178
 
# File 'doc_db_elastic/cfn_cluster.rb', line 176

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


186
187
188
 
# File 'doc_db_elastic/cfn_cluster.rb', line 186

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


671
672
673
674
 
# File 'doc_db_elastic/cfn_cluster.rb', line 671

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 the new elastic cluster.

Returns:

  • (Array<String>, nil) 


385
386
387
 
# File 'doc_db_elastic/cfn_cluster.rb', line 385

def vpc_security_group_ids()
  jsii_get_property("vpcSecurityGroupIds")
end

#vpc_security_group_ids=(value) ⇒ Object 



389
390
391
392
 
# File 'doc_db_elastic/cfn_cluster.rb', line 389

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) 


410
411
412
413
414
415
 
# File 'doc_db_elastic/cfn_cluster.rb', line 410

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