Class: AWSCDK::Neptune::CfnDBCluster

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

Overview

The AWS::Neptune::DBCluster resource creates an Amazon Neptune DB cluster. Neptune is a fully managed graph database.

Currently, you can create this resource only in AWS Regions in which Amazon Neptune is supported.

If no DeletionPolicy is set for AWS::Neptune::DBCluster resources, the default deletion behavior is that the entire volume will be deleted without a snapshot. To retain a backup of the volume, the DeletionPolicy should be set to Snapshot . For more information about how CloudFormation deletes resources, see DeletionPolicy Attribute .

You can use AWS::Neptune::DBCluster.DeletionProtection to help guard against unintended deletion of your DB cluster.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

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

    Resource properties.



24
25
26
27
28
29
30
 
# File 'neptune/cfn_db_cluster.rb', line 24

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

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


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

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

.is_cfn_db_cluster(x) ⇒ Boolean

Checks whether the given object is a CfnDBCluster.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

def self.is_cfn_db_cluster(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_neptune.CfnDBCluster", "isCfnDBCluster", [x])
end

.jsii_overridable_methods ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'neptune/cfn_db_cluster.rb', line 32

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_cluster_resource_id => { kind: :property, name: "attrClusterResourceId", is_optional: false },
    :attr_endpoint => { kind: :property, name: "attrEndpoint", is_optional: false },
    :attr_port => { kind: :property, name: "attrPort", is_optional: false },
    :attr_read_endpoint => { kind: :property, name: "attrReadEndpoint", is_optional: false },
    :db_cluster_ref => { kind: :property, name: "dbClusterRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :associated_roles => { kind: :property, name: "associatedRoles", is_optional: true },
    :availability_zones => { kind: :property, name: "availabilityZones", is_optional: true },
    :backup_retention_period => { kind: :property, name: "backupRetentionPeriod", is_optional: true },
    :copy_tags_to_snapshot => { kind: :property, name: "copyTagsToSnapshot", is_optional: true },
    :db_cluster_identifier => { kind: :property, name: "dbClusterIdentifier", is_optional: true },
    :db_cluster_parameter_group_name => { kind: :property, name: "dbClusterParameterGroupName", is_optional: true },
    :db_instance_parameter_group_name => { kind: :property, name: "dbInstanceParameterGroupName", is_optional: true },
    :db_port => { kind: :property, name: "dbPort", is_optional: true },
    :db_subnet_group_name => { kind: :property, name: "dbSubnetGroupName", is_optional: true },
    :deletion_protection => { kind: :property, name: "deletionProtection", is_optional: true },
    :enable_cloudwatch_logs_exports => { kind: :property, name: "enableCloudwatchLogsExports", is_optional: true },
    :engine_version => { kind: :property, name: "engineVersion", is_optional: true },
    :global_cluster_identifier => { kind: :property, name: "globalClusterIdentifier", is_optional: true },
    :iam_auth_enabled => { kind: :property, name: "iamAuthEnabled", is_optional: true },
    :kms_key_id => { kind: :property, name: "kmsKeyId", is_optional: true },
    :network_type => { kind: :property, name: "networkType", is_optional: true },
    :preferred_backup_window => { kind: :property, name: "preferredBackupWindow", is_optional: true },
    :preferred_maintenance_window => { kind: :property, name: "preferredMaintenanceWindow", is_optional: true },
    :restore_to_time => { kind: :property, name: "restoreToTime", is_optional: true },
    :restore_type => { kind: :property, name: "restoreType", is_optional: true },
    :serverless_scaling_configuration => { kind: :property, name: "serverlessScalingConfiguration", is_optional: true },
    :snapshot_identifier => { kind: :property, name: "snapshotIdentifier", is_optional: true },
    :source_db_cluster_identifier => { kind: :property, name: "sourceDbClusterIdentifier", is_optional: true },
    :storage_encrypted => { kind: :property, name: "storageEncrypted", is_optional: true },
    :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.



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

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:



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

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:



645
646
647
648
 
# File 'neptune/cfn_db_cluster.rb', line 645

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:



656
657
658
659
660
 
# File 'neptune/cfn_db_cluster.rb', line 656

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.


713
714
715
716
717
 
# File 'neptune/cfn_db_cluster.rb', line 713

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.



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

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.



735
736
737
738
739
 
# File 'neptune/cfn_db_cluster.rb', line 735

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



748
749
750
751
 
# File 'neptune/cfn_db_cluster.rb', line 748

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:



770
771
772
773
774
775
 
# File 'neptune/cfn_db_cluster.rb', line 770

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 Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster.

Returns:



262
263
264
 
# File 'neptune/cfn_db_cluster.rb', line 262

def associated_roles()
  jsii_get_property("associatedRoles")
end

#associated_roles=(value) ⇒ Object 



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

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

#attr_cluster_resource_id ⇒ String

The resource id for the DB cluster.

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

Returns:

  • (String) 


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

def attr_cluster_resource_id()
  jsii_get_property("attrClusterResourceId")
end

#attr_endpoint ⇒ String

The connection endpoint for the DB cluster.

For example: mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com

Returns:

  • (String) 


225
226
227
 
# File 'neptune/cfn_db_cluster.rb', line 225

def attr_endpoint()
  jsii_get_property("attrEndpoint")
end

#attr_port ⇒ String

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

Returns:

  • (String) 


232
233
234
 
# File 'neptune/cfn_db_cluster.rb', line 232

def attr_port()
  jsii_get_property("attrPort")
end

#attr_read_endpoint ⇒ String

The reader endpoint for the DB cluster.

For example: mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com

Returns:

  • (String) 


241
242
243
 
# File 'neptune/cfn_db_cluster.rb', line 241

def attr_read_endpoint()
  jsii_get_property("attrReadEndpoint")
end

#availability_zones ⇒ Array<String>?

Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

Returns:

  • (Array<String>, nil) 


274
275
276
 
# File 'neptune/cfn_db_cluster.rb', line 274

def availability_zones()
  jsii_get_property("availabilityZones")
end

#availability_zones=(value) ⇒ Object 



278
279
280
281
 
# File 'neptune/cfn_db_cluster.rb', line 278

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

#backup_retention_period ⇒ Numeric?

Specifies the number of days for which automatic DB snapshots are retained.

Returns:

  • (Numeric, nil) 


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

def backup_retention_period()
  jsii_get_property("backupRetentionPeriod")
end

#backup_retention_period=(value) ⇒ Object 



290
291
292
293
 
# File 'neptune/cfn_db_cluster.rb', line 290

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



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

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


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

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


779
780
781
782
 
# File 'neptune/cfn_db_cluster.rb', line 779

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


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

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


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

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#copy_tags_to_snapshot ⇒ Boolean, ...

If set to true , tags are copied to any snapshot of the DB cluster that is created..

Returns:



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

def copy_tags_to_snapshot()
  jsii_get_property("copyTagsToSnapshot")
end

#copy_tags_to_snapshot=(value) ⇒ Object 



302
303
304
305
 
# File 'neptune/cfn_db_cluster.rb', line 302

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


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

def creation_stack()
  jsii_get_property("creationStack")
end

#db_cluster_identifier ⇒ String?

Contains a user-supplied DB cluster identifier.

Returns:

  • (String, nil) 


310
311
312
 
# File 'neptune/cfn_db_cluster.rb', line 310

def db_cluster_identifier()
  jsii_get_property("dbClusterIdentifier")
end

#db_cluster_identifier=(value) ⇒ Object 



314
315
316
317
 
# File 'neptune/cfn_db_cluster.rb', line 314

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

#db_cluster_parameter_group_name ⇒ String?

Provides the name of the DB cluster parameter group.

Returns:

  • (String, nil) 


322
323
324
 
# File 'neptune/cfn_db_cluster.rb', line 322

def db_cluster_parameter_group_name()
  jsii_get_property("dbClusterParameterGroupName")
end

#db_cluster_parameter_group_name=(value) ⇒ Object 



326
327
328
329
 
# File 'neptune/cfn_db_cluster.rb', line 326

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

A reference to a DBCluster resource.

Returns:



248
249
250
 
# File 'neptune/cfn_db_cluster.rb', line 248

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) 


334
335
336
 
# File 'neptune/cfn_db_cluster.rb', line 334

def db_instance_parameter_group_name()
  jsii_get_property("dbInstanceParameterGroupName")
end

#db_instance_parameter_group_name=(value) ⇒ Object 



338
339
340
341
 
# File 'neptune/cfn_db_cluster.rb', line 338

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_port ⇒ Numeric?

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

Returns:

  • (Numeric, nil) 


346
347
348
 
# File 'neptune/cfn_db_cluster.rb', line 346

def db_port()
  jsii_get_property("dbPort")
end

#db_port=(value) ⇒ Object 



350
351
352
353
 
# File 'neptune/cfn_db_cluster.rb', line 350

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

#db_subnet_group_name ⇒ String?

Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

Returns:

  • (String, nil) 


358
359
360
 
# File 'neptune/cfn_db_cluster.rb', line 358

def db_subnet_group_name()
  jsii_get_property("dbSubnetGroupName")
end

#db_subnet_group_name=(value) ⇒ Object 



362
363
364
365
 
# File 'neptune/cfn_db_cluster.rb', line 362

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

#deletion_protection ⇒ Boolean, ...

Indicates whether or not the DB cluster has deletion protection enabled.

Returns:



370
371
372
 
# File 'neptune/cfn_db_cluster.rb', line 370

def deletion_protection()
  jsii_get_property("deletionProtection")
end

#deletion_protection=(value) ⇒ Object 



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

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

#enable_cloudwatch_logs_exports ⇒ Array<String>?

Specifies a list of log types that are enabled for export to CloudWatch Logs.

Returns:

  • (Array<String>, nil) 


382
383
384
 
# File 'neptune/cfn_db_cluster.rb', line 382

def enable_cloudwatch_logs_exports()
  jsii_get_property("enableCloudwatchLogsExports")
end

#enable_cloudwatch_logs_exports=(value) ⇒ Object 



386
387
388
389
 
# File 'neptune/cfn_db_cluster.rb', line 386

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

#engine_version ⇒ String?

Indicates the database engine version.

Returns:

  • (String, nil) 


394
395
396
 
# File 'neptune/cfn_db_cluster.rb', line 394

def engine_version()
  jsii_get_property("engineVersion")
end

#engine_version=(value) ⇒ Object 



398
399
400
401
 
# File 'neptune/cfn_db_cluster.rb', line 398

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



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

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



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

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:



803
804
805
806
 
# File 'neptune/cfn_db_cluster.rb', line 803

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

#global_cluster_identifier ⇒ String?

The ID of the Neptune global database to which this new DB cluster should be added.

Returns:

  • (String, nil) 


406
407
408
 
# File 'neptune/cfn_db_cluster.rb', line 406

def global_cluster_identifier()
  jsii_get_property("globalClusterIdentifier")
end

#global_cluster_identifier=(value) ⇒ Object 



410
411
412
413
 
# File 'neptune/cfn_db_cluster.rb', line 410

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

#iam_auth_enabled ⇒ Boolean, ...

True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

Returns:



418
419
420
 
# File 'neptune/cfn_db_cluster.rb', line 418

def iam_auth_enabled()
  jsii_get_property("iamAuthEnabled")
end

#iam_auth_enabled=(value) ⇒ Object 



422
423
424
425
 
# File 'neptune/cfn_db_cluster.rb', line 422

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



873
874
875
876
 
# File 'neptune/cfn_db_cluster.rb', line 873

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 Amazon Resource Name (ARN) of the 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) 


430
431
432
 
# File 'neptune/cfn_db_cluster.rb', line 430

def kms_key_id()
  jsii_get_property("kmsKeyId")
end

#kms_key_id=(value) ⇒ Object 



434
435
436
437
 
# File 'neptune/cfn_db_cluster.rb', line 434

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

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

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

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


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

def logical_id()
  jsii_get_property("logicalId")
end

#network_type ⇒ String?

The network type of the DB cluster.

Returns:

  • (String, nil) 


442
443
444
 
# File 'neptune/cfn_db_cluster.rb', line 442

def network_type()
  jsii_get_property("networkType")
end

#network_type=(value) ⇒ Object 



446
447
448
449
 
# File 'neptune/cfn_db_cluster.rb', line 446

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


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

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



814
815
816
 
# File 'neptune/cfn_db_cluster.rb', line 814

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:



821
822
823
 
# File 'neptune/cfn_db_cluster.rb', line 821

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.



614
615
616
617
 
# File 'neptune/cfn_db_cluster.rb', line 614

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?

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .

Returns:

  • (String, nil) 


454
455
456
 
# File 'neptune/cfn_db_cluster.rb', line 454

def preferred_backup_window()
  jsii_get_property("preferredBackupWindow")
end

#preferred_backup_window=(value) ⇒ Object 



458
459
460
461
 
# File 'neptune/cfn_db_cluster.rb', line 458

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?

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

Returns:

  • (String, nil) 


466
467
468
 
# File 'neptune/cfn_db_cluster.rb', line 466

def preferred_maintenance_window()
  jsii_get_property("preferredMaintenanceWindow")
end

#preferred_maintenance_window=(value) ⇒ Object 



470
471
472
473
 
# File 'neptune/cfn_db_cluster.rb', line 470

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

#ref ⇒ String

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

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

Returns:

  • (String) 


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

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



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

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


839
840
841
842
 
# File 'neptune/cfn_db_cluster.rb', line 839

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:



849
850
851
852
853
 
# File 'neptune/cfn_db_cluster.rb', line 849

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#restore_to_time ⇒ String?

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

Returns:

  • (String, nil) 


478
479
480
 
# File 'neptune/cfn_db_cluster.rb', line 478

def restore_to_time()
  jsii_get_property("restoreToTime")
end

#restore_to_time=(value) ⇒ Object 



482
483
484
485
 
# File 'neptune/cfn_db_cluster.rb', line 482

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?

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

Returns:

  • (String, nil) 


490
491
492
 
# File 'neptune/cfn_db_cluster.rb', line 490

def restore_type()
  jsii_get_property("restoreType")
end

#restore_type=(value) ⇒ Object 



494
495
496
497
 
# File 'neptune/cfn_db_cluster.rb', line 494

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

#serverless_scaling_configuration ⇒ AWSCDK::IResolvable, ...

Contains the scaling configuration of an Neptune Serverless DB cluster.

Returns:



502
503
504
 
# File 'neptune/cfn_db_cluster.rb', line 502

def serverless_scaling_configuration()
  jsii_get_property("serverlessScalingConfiguration")
end

#serverless_scaling_configuration=(value) ⇒ Object 



506
507
508
509
510
 
# File 'neptune/cfn_db_cluster.rb', line 506

def serverless_scaling_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Neptune::CfnDBCluster::ServerlessScalingConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19uZXB0dW5lLkNmbkRCQ2x1c3Rlci5TZXJ2ZXJsZXNzU2NhbGluZ0NvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "serverlessScalingConfiguration") unless value.nil?
  jsii_set_property("serverlessScalingConfiguration", 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.



858
859
860
 
# File 'neptune/cfn_db_cluster.rb', line 858

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

#snapshot_identifier ⇒ String?

Specifies the identifier for a DB cluster snapshot.

Must match the identifier of an existing snapshot.

Returns:

  • (String, nil) 


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

def snapshot_identifier()
  jsii_get_property("snapshotIdentifier")
end

#snapshot_identifier=(value) ⇒ Object 



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

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?

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

Returns:

  • (String, nil) 


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

def source_db_cluster_identifier()
  jsii_get_property("sourceDbClusterIdentifier")
end

#source_db_cluster_identifier=(value) ⇒ Object 



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

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

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



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

def stack()
  jsii_get_property("stack")
end

#storage_encrypted ⇒ Boolean, ...

Indicates whether the DB cluster is encrypted.

Returns:



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

def storage_encrypted()
  jsii_get_property("storageEncrypted")
end

#storage_encrypted=(value) ⇒ Object 



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

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

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



255
256
257
 
# File 'neptune/cfn_db_cluster.rb', line 255

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

The tags assigned to this cluster.

Returns:



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

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



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

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



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

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

#updated_properites ⇒ Hash{String => Object}

Deprecated.

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

Deprecated.

Returns:

  • (Hash{String => Object}) 


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

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


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

def updated_properties()
  jsii_get_property("updatedProperties")
end

#use_latest_restorable_time ⇒ Boolean, ...

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

Returns:



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

def use_latest_restorable_time()
  jsii_get_property("useLatestRestorableTime")
end

#use_latest_restorable_time=(value) ⇒ Object 



570
571
572
573
 
# File 'neptune/cfn_db_cluster.rb', line 570

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) 


864
865
866
867
 
# File 'neptune/cfn_db_cluster.rb', line 864

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

Provides a list of VPC security groups that the DB cluster belongs to.

Returns:

  • (Array<String>, nil) 


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

def vpc_security_group_ids()
  jsii_get_property("vpcSecurityGroupIds")
end

#vpc_security_group_ids=(value) ⇒ Object 



582
583
584
585
 
# File 'neptune/cfn_db_cluster.rb', line 582

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) 


603
604
605
606
607
608
 
# File 'neptune/cfn_db_cluster.rb', line 603

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