Class: AWSCDK::RDS::CfnDBProxy

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSRDS::IDBProxyRef
Defined in:
rds/cfn_db_proxy.rb

Overview

The AWS::RDS::DBProxy resource creates or updates a DB proxy.

For information about RDS Proxy for Amazon RDS, see Managing Connections with Amazon RDS Proxy in the Amazon RDS User Guide .

For information about RDS Proxy for Amazon Aurora, see Managing Connections with Amazon RDS Proxy in the Amazon Aurora User Guide .

Limitations apply to RDS Proxy, including DB engine version limitations and AWS Region limitations.

For information about limitations that apply to RDS Proxy for Amazon RDS, see Limitations for RDS Proxy in the Amazon RDS User Guide .

For information about that apply to RDS Proxy for Amazon Aurora, see Limitations for RDS Proxy in the Amazon Aurora User Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnDBProxy

Create a new AWS::RDS::DBProxy.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::RDS::CfnDBProxyProps) —

    Resource properties.



28
29
30
31
32
33
34
 
# File 'rds/cfn_db_proxy.rb', line 28

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

Class Method Details

.arn_for_db_proxy(resource) ⇒ String

Parameters:

Returns:

  • (String) 


96
97
98
99
 
# File 'rds/cfn_db_proxy.rb', line 96

def self.arn_for_db_proxy(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19yZHMuSURCUHJveHlSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_rds.CfnDBProxy", "arnForDBProxy", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


203
204
205
 
# File 'rds/cfn_db_proxy.rb', line 203

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

.is_cfn_db_proxy(x) ⇒ Boolean

Checks whether the given object is a CfnDBProxy.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


105
106
107
108
 
# File 'rds/cfn_db_proxy.rb', line 105

def self.is_cfn_db_proxy(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_rds.CfnDBProxy", "isCfnDBProxy", [x])
end

.jsii_overridable_methods ⇒ Object 



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
 
# File 'rds/cfn_db_proxy.rb', line 36

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_db_proxy_arn => { kind: :property, name: "attrDbProxyArn", is_optional: false },
    :attr_endpoint => { kind: :property, name: "attrEndpoint", is_optional: false },
    :attr_vpc_id => { kind: :property, name: "attrVpcId", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :db_proxy_ref => { kind: :property, name: "dbProxyRef", is_optional: false },
    :db_proxy_name => { kind: :property, name: "dbProxyName", is_optional: false },
    :engine_family => { kind: :property, name: "engineFamily", is_optional: false },
    :role_arn => { kind: :property, name: "roleArn", is_optional: false },
    :vpc_subnet_ids => { kind: :property, name: "vpcSubnetIds", is_optional: false },
    :auth => { kind: :property, name: "auth", is_optional: true },
    :debug_logging => { kind: :property, name: "debugLogging", is_optional: true },
    :default_auth_scheme => { kind: :property, name: "defaultAuthScheme", is_optional: true },
    :endpoint_network_type => { kind: :property, name: "endpointNetworkType", is_optional: true },
    :idle_client_timeout => { kind: :property, name: "idleClientTimeout", is_optional: true },
    :require_tls => { kind: :property, name: "requireTls", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :target_connection_network_type => { kind: :property, name: "targetConnectionNetworkType", 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.



437
438
439
440
 
# File 'rds/cfn_db_proxy.rb', line 437

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:



449
450
451
452
 
# File 'rds/cfn_db_proxy.rb', line 449

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:



459
460
461
462
 
# File 'rds/cfn_db_proxy.rb', line 459

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:



470
471
472
473
474
 
# File 'rds/cfn_db_proxy.rb', line 470

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.


527
528
529
530
531
 
# File 'rds/cfn_db_proxy.rb', line 527

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.



537
538
539
540
 
# File 'rds/cfn_db_proxy.rb', line 537

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.



549
550
551
552
553
 
# File 'rds/cfn_db_proxy.rb', line 549

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:



562
563
564
565
 
# File 'rds/cfn_db_proxy.rb', line 562

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:



584
585
586
587
588
589
 
# File 'rds/cfn_db_proxy.rb', line 584

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

The Amazon Resource Name (ARN) for the proxy.

Returns:

  • (String) 


210
211
212
 
# File 'rds/cfn_db_proxy.rb', line 210

def attr_db_proxy_arn()
  jsii_get_property("attrDbProxyArn")
end

#attr_endpoint ⇒ String

The endpoint that you can use to connect to the DB proxy.

You include the endpoint value in the connection string for a database client application.

Returns:

  • (String) 


219
220
221
 
# File 'rds/cfn_db_proxy.rb', line 219

def attr_endpoint()
  jsii_get_property("attrEndpoint")
end

#attr_vpc_id ⇒ String

The VPC ID to associate with the DB proxy.

Returns:

  • (String) 


226
227
228
 
# File 'rds/cfn_db_proxy.rb', line 226

def attr_vpc_id()
  jsii_get_property("attrVpcId")
end

#auth ⇒ AWSCDK::IResolvable, ...

The authorization mechanism that the proxy uses.

Returns:



295
296
297
 
# File 'rds/cfn_db_proxy.rb', line 295

def auth()
  jsii_get_property("auth")
end

#auth=(value) ⇒ Object 



299
300
301
302
 
# File 'rds/cfn_db_proxy.rb', line 299

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

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



233
234
235
 
# File 'rds/cfn_db_proxy.rb', line 233

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



156
157
158
 
# File 'rds/cfn_db_proxy.rb', line 156

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


161
162
163
 
# File 'rds/cfn_db_proxy.rb', line 161

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


593
594
595
596
 
# File 'rds/cfn_db_proxy.rb', line 593

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


166
167
168
 
# File 'rds/cfn_db_proxy.rb', line 166

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


173
174
175
 
# File 'rds/cfn_db_proxy.rb', line 173

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


118
119
120
 
# File 'rds/cfn_db_proxy.rb', line 118

def creation_stack()
  jsii_get_property("creationStack")
end

#db_proxy_name ⇒ String

The identifier for the proxy.

Returns:

  • (String) 


247
248
249
 
# File 'rds/cfn_db_proxy.rb', line 247

def db_proxy_name()
  jsii_get_property("dbProxyName")
end

#db_proxy_name=(value) ⇒ Object 



251
252
253
254
 
# File 'rds/cfn_db_proxy.rb', line 251

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

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

A reference to a DBProxy resource.

Returns:



240
241
242
 
# File 'rds/cfn_db_proxy.rb', line 240

def db_proxy_ref()
  jsii_get_property("dbProxyRef")
end

#debug_logging ⇒ Boolean, ...

Specifies whether the proxy logs detailed connection and query information.

Returns:



307
308
309
 
# File 'rds/cfn_db_proxy.rb', line 307

def debug_logging()
  jsii_get_property("debugLogging")
end

#debug_logging=(value) ⇒ Object 



311
312
313
314
 
# File 'rds/cfn_db_proxy.rb', line 311

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

#default_auth_scheme ⇒ String?

The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database.

Returns:

  • (String, nil) 


319
320
321
 
# File 'rds/cfn_db_proxy.rb', line 319

def default_auth_scheme()
  jsii_get_property("defaultAuthScheme")
end

#default_auth_scheme=(value) ⇒ Object 



323
324
325
326
 
# File 'rds/cfn_db_proxy.rb', line 323

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

#endpoint_network_type ⇒ String?

The network type of the DB proxy endpoint.

Returns:

  • (String, nil) 


331
332
333
 
# File 'rds/cfn_db_proxy.rb', line 331

def endpoint_network_type()
  jsii_get_property("endpointNetworkType")
end

#endpoint_network_type=(value) ⇒ Object 



335
336
337
338
 
# File 'rds/cfn_db_proxy.rb', line 335

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

#engine_family ⇒ String

The kinds of databases that the proxy can connect to.

Returns:

  • (String) 


259
260
261
 
# File 'rds/cfn_db_proxy.rb', line 259

def engine_family()
  jsii_get_property("engineFamily")
end

#engine_family=(value) ⇒ Object 



263
264
265
266
 
# File 'rds/cfn_db_proxy.rb', line 263

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



178
179
180
 
# File 'rds/cfn_db_proxy.rb', line 178

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:



606
607
608
609
610
 
# File 'rds/cfn_db_proxy.rb', line 606

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:



617
618
619
620
 
# File 'rds/cfn_db_proxy.rb', line 617

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

#idle_client_timeout ⇒ Numeric?

The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.

Returns:

  • (Numeric, nil) 


343
344
345
 
# File 'rds/cfn_db_proxy.rb', line 343

def idle_client_timeout()
  jsii_get_property("idleClientTimeout")
end

#idle_client_timeout=(value) ⇒ Object 



347
348
349
350
 
# File 'rds/cfn_db_proxy.rb', line 347

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



687
688
689
690
 
# File 'rds/cfn_db_proxy.rb', line 687

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) 


130
131
132
 
# File 'rds/cfn_db_proxy.rb', line 130

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


113
114
115
 
# File 'rds/cfn_db_proxy.rb', line 113

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:



628
629
630
 
# File 'rds/cfn_db_proxy.rb', line 628

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:



635
636
637
 
# File 'rds/cfn_db_proxy.rb', line 635

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.



428
429
430
431
 
# File 'rds/cfn_db_proxy.rb', line 428

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

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


149
150
151
 
# File 'rds/cfn_db_proxy.rb', line 149

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:



646
647
648
649
 
# File 'rds/cfn_db_proxy.rb', line 646

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


653
654
655
656
 
# File 'rds/cfn_db_proxy.rb', line 653

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:



663
664
665
666
667
 
# File 'rds/cfn_db_proxy.rb', line 663

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

#require_tls ⇒ Boolean, ...

Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

Returns:



355
356
357
 
# File 'rds/cfn_db_proxy.rb', line 355

def require_tls()
  jsii_get_property("requireTls")
end

#require_tls=(value) ⇒ Object 



359
360
361
362
 
# File 'rds/cfn_db_proxy.rb', line 359

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

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.

Returns:

  • (String) 


271
272
273
 
# File 'rds/cfn_db_proxy.rb', line 271

def role_arn()
  jsii_get_property("roleArn")
end

#role_arn=(value) ⇒ Object 



275
276
277
278
 
# File 'rds/cfn_db_proxy.rb', line 275

def role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  jsii_set_property("roleArn", 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.



672
673
674
 
# File 'rds/cfn_db_proxy.rb', line 672

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:



139
140
141
 
# File 'rds/cfn_db_proxy.rb', line 139

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::RDS::CfnDBProxy::TagFormatProperty>?

An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

Returns:



367
368
369
 
# File 'rds/cfn_db_proxy.rb', line 367

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



371
372
373
374
375
 
# File 'rds/cfn_db_proxy.rb', line 371

def tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::RDS::CfnDBProxy::TagFormatProperty.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19yZHMuQ2ZuREJQcm94eS5UYWdGb3JtYXRQcm9wZXJ0eSJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#target_connection_network_type ⇒ String?

The network type that the proxy uses to connect to the target database.

Returns:

  • (String, nil) 


380
381
382
 
# File 'rds/cfn_db_proxy.rb', line 380

def target_connection_network_type()
  jsii_get_property("targetConnectionNetworkType")
end

#target_connection_network_type=(value) ⇒ Object 



384
385
386
387
 
# File 'rds/cfn_db_proxy.rb', line 384

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



404
405
406
 
# File 'rds/cfn_db_proxy.rb', line 404

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


186
187
188
 
# File 'rds/cfn_db_proxy.rb', line 186

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


196
197
198
 
# File 'rds/cfn_db_proxy.rb', line 196

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


678
679
680
681
 
# File 'rds/cfn_db_proxy.rb', line 678

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

One or more VPC security group IDs to associate with the new proxy.

Returns:

  • (Array<String>, nil) 


392
393
394
 
# File 'rds/cfn_db_proxy.rb', line 392

def vpc_security_group_ids()
  jsii_get_property("vpcSecurityGroupIds")
end

#vpc_security_group_ids=(value) ⇒ Object 



396
397
398
399
 
# File 'rds/cfn_db_proxy.rb', line 396

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

#vpc_subnet_ids ⇒ Array<String>

One or more VPC subnet IDs to associate with the new proxy.

Returns:

  • (Array<String>) 


283
284
285
 
# File 'rds/cfn_db_proxy.rb', line 283

def vpc_subnet_ids()
  jsii_get_property("vpcSubnetIds")
end

#vpc_subnet_ids=(value) ⇒ Object 



287
288
289
290
 
# File 'rds/cfn_db_proxy.rb', line 287

def vpc_subnet_ids=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "vpcSubnetIds")
  jsii_set_property("vpcSubnetIds", 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) 


417
418
419
420
421
422
 
# File 'rds/cfn_db_proxy.rb', line 417

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