Class: AWSCDK::Neptune::CfnDBInstance

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

Overview

The AWS::Neptune::DBInstance type creates an Amazon Neptune DB instance.

Updating DB Instances

You can set a deletion policy for your DB instance to control how CloudFormation handles the instance when the stack is deleted. For Neptune DB instances, you can choose to retain the instance, to delete the instance, or to create a snapshot of the instance. The default CloudFormation behavior depends on the DBClusterIdentifier property:

  • For AWS::Neptune::DBInstance resources that don't specify the DBClusterIdentifier property, CloudFormation saves a snapshot of the DB instance.
  • For AWS::Neptune::DBInstance resources that do specify the DBClusterIdentifier property, CloudFormation deletes the DB instance.

Deleting DB Instances

If a DB instance is deleted or replaced during an update, CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced.

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

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

  • Deactivate any applications that are using the DB instance so that there's no activity on the DB instance.
  • Create a snapshot of the DB instance.
  • If you want to restore your instance using a DB snapshot, modify the updated template with your DB instance changes and add the DBSnapshotIdentifier property with the ID of the DB snapshot that you want to use.
  • Update the stack.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnDBInstance

Create a new AWS::Neptune::DBInstance.

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::CfnDBInstanceProps) —

    Resource properties.



38
39
40
41
42
43
44
 
# File 'neptune/cfn_db_instance.rb', line 38

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Neptune::CfnDBInstanceProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbmVwdHVuZS5DZm5EQkluc3RhbmNlUHJvcHMifQ==")), "props")
  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) 


204
205
206
 
# File 'neptune/cfn_db_instance.rb', line 204

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

.is_cfn_db_instance(x) ⇒ Boolean

Checks whether the given object is a CfnDBInstance.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


106
107
108
109
 
# File 'neptune/cfn_db_instance.rb', line 106

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

.jsii_overridable_methods ⇒ Object 



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
 
# File 'neptune/cfn_db_instance.rb', line 46

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_endpoint => { kind: :property, name: "attrEndpoint", is_optional: false },
    :attr_port => { kind: :property, name: "attrPort", is_optional: false },
    :db_instance_ref => { kind: :property, name: "dbInstanceRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :db_instance_class => { kind: :property, name: "dbInstanceClass", is_optional: false },
    :allow_major_version_upgrade => { kind: :property, name: "allowMajorVersionUpgrade", is_optional: true },
    :auto_minor_version_upgrade => { kind: :property, name: "autoMinorVersionUpgrade", is_optional: true },
    :availability_zone => { kind: :property, name: "availabilityZone", is_optional: true },
    :db_cluster_identifier => { kind: :property, name: "dbClusterIdentifier", is_optional: true },
    :db_instance_identifier => { kind: :property, name: "dbInstanceIdentifier", is_optional: true },
    :db_parameter_group_name => { kind: :property, name: "dbParameterGroupName", is_optional: true },
    :db_snapshot_identifier => { kind: :property, name: "dbSnapshotIdentifier", is_optional: true },
    :db_subnet_group_name => { kind: :property, name: "dbSubnetGroupName", is_optional: true },
    :preferred_maintenance_window => { kind: :property, name: "preferredMaintenanceWindow", is_optional: true },
    :publicly_accessible => { kind: :property, name: "publiclyAccessible", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", 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.



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

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:



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

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:



444
445
446
447
 
# File 'neptune/cfn_db_instance.rb', line 444

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:



455
456
457
458
459
 
# File 'neptune/cfn_db_instance.rb', line 455

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.


512
513
514
515
516
 
# File 'neptune/cfn_db_instance.rb', line 512

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.



522
523
524
525
 
# File 'neptune/cfn_db_instance.rb', line 522

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.



534
535
536
537
538
 
# File 'neptune/cfn_db_instance.rb', line 534

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

#allow_major_version_upgrade ⇒ Boolean, ...

Indicates that major version upgrades are allowed.

Returns:



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

def allow_major_version_upgrade()
  jsii_get_property("allowMajorVersionUpgrade")
end

#allow_major_version_upgrade=(value) ⇒ Object 



259
260
261
262
 
# File 'neptune/cfn_db_instance.rb', line 259

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



547
548
549
550
 
# File 'neptune/cfn_db_instance.rb', line 547

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:



569
570
571
572
573
574
 
# File 'neptune/cfn_db_instance.rb', line 569

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

The connection endpoint for the database.

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

Returns:

  • (String) 


213
214
215
 
# File 'neptune/cfn_db_instance.rb', line 213

def attr_endpoint()
  jsii_get_property("attrEndpoint")
end

#attr_port ⇒ String

The port number on which the database accepts connections.

For example: 8182 .

Returns:

  • (String) 


222
223
224
 
# File 'neptune/cfn_db_instance.rb', line 222

def attr_port()
  jsii_get_property("attrPort")
end

#auto_minor_version_upgrade ⇒ Boolean, ...

Indicates that minor version patches are applied automatically.

Returns:



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

def auto_minor_version_upgrade()
  jsii_get_property("autoMinorVersionUpgrade")
end

#auto_minor_version_upgrade=(value) ⇒ Object 



271
272
273
274
 
# File 'neptune/cfn_db_instance.rb', line 271

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

#availability_zone ⇒ String?

Specifies the name of the Availability Zone the DB instance is located in.

Returns:

  • (String, nil) 


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

def availability_zone()
  jsii_get_property("availabilityZone")
end

#availability_zone=(value) ⇒ Object 



283
284
285
286
 
# File 'neptune/cfn_db_instance.rb', line 283

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



157
158
159
 
# File 'neptune/cfn_db_instance.rb', line 157

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


162
163
164
 
# File 'neptune/cfn_db_instance.rb', line 162

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


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

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


167
168
169
 
# File 'neptune/cfn_db_instance.rb', line 167

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


174
175
176
 
# File 'neptune/cfn_db_instance.rb', line 174

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


119
120
121
 
# File 'neptune/cfn_db_instance.rb', line 119

def creation_stack()
  jsii_get_property("creationStack")
end

#db_cluster_identifier ⇒ String?

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

Returns:

  • (String, nil) 


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

def db_cluster_identifier()
  jsii_get_property("dbClusterIdentifier")
end

#db_cluster_identifier=(value) ⇒ Object 



295
296
297
298
 
# File 'neptune/cfn_db_instance.rb', line 295

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

Contains the name of the compute and memory capacity class of the DB instance.

Returns:

  • (String) 


243
244
245
 
# File 'neptune/cfn_db_instance.rb', line 243

def db_instance_class()
  jsii_get_property("dbInstanceClass")
end

#db_instance_class=(value) ⇒ Object 



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

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

#db_instance_identifier ⇒ String?

Contains a user-supplied database identifier.

Returns:

  • (String, nil) 


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

def db_instance_identifier()
  jsii_get_property("dbInstanceIdentifier")
end

#db_instance_identifier=(value) ⇒ Object 



307
308
309
310
 
# File 'neptune/cfn_db_instance.rb', line 307

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

#db_instance_ref ⇒ AWSCDK::Interfaces::AWSNeptune::DBInstanceReference

A reference to a DBInstance resource.

Returns:



229
230
231
 
# File 'neptune/cfn_db_instance.rb', line 229

def db_instance_ref()
  jsii_get_property("dbInstanceRef")
end

#db_parameter_group_name ⇒ String?

The name of an existing DB parameter group or a reference to an AWS::Neptune::DBParameterGroup resource created in the template.

Returns:

  • (String, nil) 


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

def db_parameter_group_name()
  jsii_get_property("dbParameterGroupName")
end

#db_parameter_group_name=(value) ⇒ Object 



319
320
321
322
 
# File 'neptune/cfn_db_instance.rb', line 319

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

#db_snapshot_identifier ⇒ String?

Deprecated.

this property has been deprecated

This parameter is not supported.

Returns:

  • (String, nil) 


328
329
330
 
# File 'neptune/cfn_db_instance.rb', line 328

def db_snapshot_identifier()
  jsii_get_property("dbSnapshotIdentifier")
end

#db_snapshot_identifier=(value) ⇒ Object 



332
333
334
335
 
# File 'neptune/cfn_db_instance.rb', line 332

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

#db_subnet_group_name ⇒ String?

A DB subnet group to associate with the DB instance.

Returns:

  • (String, nil) 


340
341
342
 
# File 'neptune/cfn_db_instance.rb', line 340

def db_subnet_group_name()
  jsii_get_property("dbSubnetGroupName")
end

#db_subnet_group_name=(value) ⇒ Object 



344
345
346
347
 
# File 'neptune/cfn_db_instance.rb', line 344

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



179
180
181
 
# File 'neptune/cfn_db_instance.rb', line 179

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:



591
592
593
594
595
 
# File 'neptune/cfn_db_instance.rb', line 591

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:



602
603
604
605
 
# File 'neptune/cfn_db_instance.rb', line 602

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:



672
673
674
675
 
# File 'neptune/cfn_db_instance.rb', line 672

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
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) 


131
132
133
 
# File 'neptune/cfn_db_instance.rb', line 131

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


114
115
116
 
# File 'neptune/cfn_db_instance.rb', line 114

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:



613
614
615
 
# File 'neptune/cfn_db_instance.rb', line 613

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:



620
621
622
 
# File 'neptune/cfn_db_instance.rb', line 620

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.



413
414
415
416
 
# File 'neptune/cfn_db_instance.rb', line 413

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

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

Returns:

  • (String, nil) 


352
353
354
 
# File 'neptune/cfn_db_instance.rb', line 352

def preferred_maintenance_window()
  jsii_get_property("preferredMaintenanceWindow")
end

#preferred_maintenance_window=(value) ⇒ Object 



356
357
358
359
 
# File 'neptune/cfn_db_instance.rb', line 356

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

#publicly_accessible ⇒ Boolean, ...

Indicates whether the DB instance is publicly accessible.

Returns:



364
365
366
 
# File 'neptune/cfn_db_instance.rb', line 364

def publicly_accessible()
  jsii_get_property("publiclyAccessible")
end

#publicly_accessible=(value) ⇒ Object 



368
369
370
371
 
# File 'neptune/cfn_db_instance.rb', line 368

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

#ref ⇒ String

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

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

Returns:

  • (String) 


150
151
152
 
# File 'neptune/cfn_db_instance.rb', line 150

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:



631
632
633
634
 
# File 'neptune/cfn_db_instance.rb', line 631

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


638
639
640
641
 
# File 'neptune/cfn_db_instance.rb', line 638

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:



648
649
650
651
652
 
# File 'neptune/cfn_db_instance.rb', line 648

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

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



657
658
659
 
# File 'neptune/cfn_db_instance.rb', line 657

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:



140
141
142
 
# File 'neptune/cfn_db_instance.rb', line 140

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



236
237
238
 
# File 'neptune/cfn_db_instance.rb', line 236

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

An arbitrary set of tags (key-value pairs) for this DB instance.

Returns:



376
377
378
 
# File 'neptune/cfn_db_instance.rb', line 376

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



380
381
382
383
384
 
# File 'neptune/cfn_db_instance.rb', line 380

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



389
390
391
 
# File 'neptune/cfn_db_instance.rb', line 389

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


187
188
189
 
# File 'neptune/cfn_db_instance.rb', line 187

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


197
198
199
 
# File 'neptune/cfn_db_instance.rb', line 197

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


663
664
665
666
 
# File 'neptune/cfn_db_instance.rb', line 663

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
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) 


402
403
404
405
406
407
 
# File 'neptune/cfn_db_instance.rb', line 402

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