Module: AWSCDK::RDS::IDatabaseProxy

Includes:
IResource, Interfaces::AWSRDS::IDBProxyRef
Included in:
DatabaseProxy
Defined in:
rds/i_database_proxy.rb

Overview

DB Proxy.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'rds/i_database_proxy.rb', line 109

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_proxy_ref => { kind: :property, name: "dbProxyRef", is_optional: false },
    :db_proxy_arn => { kind: :property, name: "dbProxyArn", is_optional: false },
    :db_proxy_name => { kind: :property, name: "dbProxyName", is_optional: false },
    :endpoint => { kind: :property, name: "endpoint", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :grant_connect => { kind: :method, name: "grantConnect", 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:



92
93
94
95
 
# File 'rds/i_database_proxy.rb', line 92

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

#db_proxy_arn ⇒ String

DB Proxy ARN.

Returns:

  • (String) 


48
49
50
 
# File 'rds/i_database_proxy.rb', line 48

def db_proxy_arn()
  jsii_get_property("dbProxyArn")
end

#db_proxy_name ⇒ String

DB Proxy Name.

Returns:

  • (String) 


55
56
57
 
# File 'rds/i_database_proxy.rb', line 55

def db_proxy_name()
  jsii_get_property("dbProxyName")
end

#db_proxy_ref ⇒ AWSCDK::Interfaces::AWSRDS::DBProxyReference

A reference to a DBProxy resource.

Returns:



41
42
43
 
# File 'rds/i_database_proxy.rb', line 41

def db_proxy_ref()
  jsii_get_property("dbProxyRef")
end

#endpoint ⇒ String

Endpoint.

Returns:

  • (String) 


62
63
64
 
# File 'rds/i_database_proxy.rb', line 62

def endpoint()
  jsii_get_property("endpoint")
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 'rds/i_database_proxy.rb', line 27

def env()
  jsii_get_property("env")
end

#grant_connect(grantee, db_user = nil) ⇒ AWSCDK::IAM::Grant

Note:

Default: - if the Proxy had been provided a single Secret value, the user will be taken from that Secret

Grant the given identity connection access to the proxy.

Parameters:

  • grantee (AWSCDK::IAM::IGrantable) —

    the Principal to grant the permissions to.

  • db_user (String, nil) (defaults to: nil) —

    the name of the database user to allow connecting as to the proxy.

Returns:



103
104
105
106
107
 
# File 'rds/i_database_proxy.rb', line 103

def grant_connect(grantee, db_user = nil)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  Jsii::Type.check_type(db_user, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dbUser") unless db_user.nil?
  jsii_call_method("grantConnect", [grantee, db_user])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


12
13
14
 
# File 'rds/i_database_proxy.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 'rds/i_database_proxy.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



73
74
75
76
77
78
 
# File 'rds/i_database_proxy.rb', line 73

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