Module: AWSCDK::DocDB::IDatabaseInstance

Includes:
IResource, Interfaces::AWSDocdb::IDBInstanceRef
Included in:
DatabaseInstance
Defined in:
doc_db/i_database_instance.rb

Overview

A database instance.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'doc_db/i_database_instance.rb', line 111

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :db_instance_ref => { kind: :property, name: "dbInstanceRef", is_optional: false },
    :db_instance_endpoint_address => { kind: :property, name: "dbInstanceEndpointAddress", is_optional: false },
    :db_instance_endpoint_port => { kind: :property, name: "dbInstanceEndpointPort", is_optional: false },
    :instance_arn => { kind: :property, name: "instanceArn", is_optional: false },
    :instance_endpoint => { kind: :property, name: "instanceEndpoint", is_optional: false },
    :instance_identifier => { kind: :property, name: "instanceIdentifier", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
  }
end

Instance Method Details

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:



106
107
108
109
 
# File 'doc_db/i_database_instance.rb', line 106

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

#db_instance_endpoint_address ⇒ String

The instance endpoint address.

Returns:

  • (String) 


48
49
50
 
# File 'doc_db/i_database_instance.rb', line 48

def db_instance_endpoint_address()
  jsii_get_property("dbInstanceEndpointAddress")
end

#db_instance_endpoint_port ⇒ String

The instance endpoint port.

Returns:

  • (String) 


55
56
57
 
# File 'doc_db/i_database_instance.rb', line 55

def db_instance_endpoint_port()
  jsii_get_property("dbInstanceEndpointPort")
end

#db_instance_ref ⇒ AWSCDK::Interfaces::AWSDocdb::DBInstanceReference

A reference to a DBInstance resource.

Returns:



41
42
43
 
# File 'doc_db/i_database_instance.rb', line 41

def db_instance_ref()
  jsii_get_property("dbInstanceRef")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

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

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

Returns:



27
28
29
 
# File 'doc_db/i_database_instance.rb', line 27

def env()
  jsii_get_property("env")
end

#instance_arn ⇒ String

The instance arn.

Returns:

  • (String) 


62
63
64
 
# File 'doc_db/i_database_instance.rb', line 62

def instance_arn()
  jsii_get_property("instanceArn")
end

#instance_endpoint ⇒ AWSCDK::DocDB::Endpoint

The instance endpoint.

Returns:



69
70
71
 
# File 'doc_db/i_database_instance.rb', line 69

def instance_endpoint()
  jsii_get_property("instanceEndpoint")
end

#instance_identifier ⇒ String

The instance identifier.

Returns:

  • (String) 


76
77
78
 
# File 'doc_db/i_database_instance.rb', line 76

def instance_identifier()
  jsii_get_property("instanceIdentifier")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


12
13
14
 
# File 'doc_db/i_database_instance.rb', line 12

def node()
  jsii_get_property("node")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



34
35
36
 
# File 'doc_db/i_database_instance.rb', line 34

def stack()
  jsii_get_property("stack")
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.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



87
88
89
90
91
92
 
# File 'doc_db/i_database_instance.rb', line 87

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