Class: AWSCDK::RDS::DatabaseInstance

Inherits:
DatabaseInstanceBase
  • Object
show all
Includes:
IDatabaseInstance
Defined in:
rds/database_instance.rb

Overview

A database instance.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ DatabaseInstance

Returns a new instance of DatabaseInstance.

Parameters:



12
13
14
15
16
17
18
 
# File 'rds/database_instance.rb', line 12

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

Class Method Details

.jsii_overridable_methods ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
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
 
# File 'rds/database_instance.rb', line 20

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :connections => { kind: :property, name: "connections", 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 },
    :db_instance_ref => { kind: :property, name: "dbInstanceRef", 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 },
    :engine => { kind: :property, name: "engine", is_optional: true },
    :instance_resource_id => { kind: :property, name: "instanceResourceId", is_optional: true },
    :enable_iam_authentication => { kind: :property, name: "enableIamAuthentication", is_optional: true },
    :cloudwatch_log_groups => { kind: :property, name: "cloudwatchLogGroups", is_optional: false },
    :instance_type => { kind: :property, name: "instanceType", is_optional: false },
    :new_cfn_props => { kind: :property, name: "newCfnProps", is_optional: false },
    :source_cfn_props => { kind: :property, name: "sourceCfnProps", is_optional: false },
    :vpc => { kind: :property, name: "vpc", is_optional: false },
    :secret => { kind: :property, name: "secret", is_optional: true },
    :vpc_placement => { kind: :property, name: "vpcPlacement", is_optional: true },
    :manage_master_user_password => { kind: :property, name: "manageMasterUserPassword", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", 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 },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :add_proxy => { kind: :method, name: "addProxy", is_optional: false },
    :as_secret_attachment_target => { kind: :method, name: "asSecretAttachmentTarget", is_optional: false },
    :grant_connect => { kind: :method, name: "grantConnect", is_optional: false },
    :metric => { kind: :method, name: "metric", is_optional: false },
    :metric_cpu_utilization => { kind: :method, name: "metricCPUUtilization", is_optional: false },
    :metric_database_connections => { kind: :method, name: "metricDatabaseConnections", is_optional: false },
    :metric_freeable_memory => { kind: :method, name: "metricFreeableMemory", is_optional: false },
    :metric_free_storage_space => { kind: :method, name: "metricFreeStorageSpace", is_optional: false },
    :metric_read_iops => { kind: :method, name: "metricReadIOPS", is_optional: false },
    :metric_write_iops => { kind: :method, name: "metricWriteIOPS", is_optional: false },
    :on_event => { kind: :method, name: "onEvent", is_optional: false },
    :add_rotation_multi_user => { kind: :method, name: "addRotationMultiUser", is_optional: false },
    :add_rotation_single_user => { kind: :method, name: "addRotationSingleUser", is_optional: false },
    :set_log_retention => { kind: :method, name: "setLogRetention", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


192
193
194
 
# File 'rds/database_instance.rb', line 192

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

Instance Method Details

#add_proxy(id, options) ⇒ AWSCDK::RDS::DatabaseProxy

Add a new db proxy to this instance.

Parameters:

Returns:



344
345
346
347
348
349
 
# File 'rds/database_instance.rb', line 344

def add_proxy(id, options)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  options = options.is_a?(Hash) ? ::AWSCDK::RDS::DatabaseProxyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmRzLkRhdGFiYXNlUHJveHlPcHRpb25zIn0=")), "options")
  jsii_call_method("addProxy", [id, options])
end

#add_rotation_multi_user(id, options) ⇒ AWSCDK::SecretsManager::SecretRotation

Adds the multi user rotation to this instance.

Parameters:

Returns:



477
478
479
480
481
482
 
# File 'rds/database_instance.rb', line 477

def add_rotation_multi_user(id, options)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  options = options.is_a?(Hash) ? ::AWSCDK::RDS::RotationMultiUserOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmRzLlJvdGF0aW9uTXVsdGlVc2VyT3B0aW9ucyJ9")), "options")
  jsii_call_method("addRotationMultiUser", [id, options])
end

#add_rotation_single_user(options = nil) ⇒ AWSCDK::SecretsManager::SecretRotation

Adds the single user rotation of the master password to this instance.

Parameters:

Returns:



488
489
490
491
492
 
# File 'rds/database_instance.rb', line 488

def add_rotation_single_user(options = nil)
  options = options.is_a?(Hash) ? ::AWSCDK::RDS::RotationSingleUserOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmRzLlJvdGF0aW9uU2luZ2xlVXNlck9wdGlvbnMifQ==")), "options") unless options.nil?
  jsii_call_method("addRotationSingleUser", [options])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



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

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) ⇒ 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:



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

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

#as_secret_attachment_target ⇒ AWSCDK::SecretsManager::SecretAttachmentTargetProps

Renders the secret attachment target specifications.

Returns:



354
355
356
 
# File 'rds/database_instance.rb', line 354

def as_secret_attachment_target()
  jsii_call_method("asSecretAttachmentTarget", [])
end

#cloudwatch_log_groups ⇒ Hash{String => AWSCDK::Logs::ILogGroup}

The log group is created when cloudwatchLogsExports is set.

Each export value will create a separate log group.

Returns:



201
202
203
 
# File 'rds/database_instance.rb', line 201

def cloudwatch_log_groups()
  jsii_get_property("cloudwatchLogGroups")
end

#connections ⇒ AWSCDK::EC2::Connections

Access to network connections.

Returns:



114
115
116
 
# File 'rds/database_instance.rb', line 114

def connections()
  jsii_get_property("connections")
end

#db_instance_endpoint_address ⇒ String

The instance endpoint address.

Returns:

  • (String) 


121
122
123
 
# File 'rds/database_instance.rb', line 121

def db_instance_endpoint_address()
  jsii_get_property("dbInstanceEndpointAddress")
end

#db_instance_endpoint_port ⇒ String

The instance endpoint port.

Returns:

  • (String) 


128
129
130
 
# File 'rds/database_instance.rb', line 128

def db_instance_endpoint_port()
  jsii_get_property("dbInstanceEndpointPort")
end

#db_instance_ref ⇒ AWSCDK::Interfaces::AWSRDS::DBInstanceReference

A reference to this database instance.

Returns:



135
136
137
 
# File 'rds/database_instance.rb', line 135

def db_instance_ref()
  jsii_get_property("dbInstanceRef")
end

#enable_iam_authentication ⇒ Boolean?

Returns:

  • (Boolean, nil) 


180
181
182
 
# File 'rds/database_instance.rb', line 180

def enable_iam_authentication()
  jsii_get_property("enableIamAuthentication")
end

#enable_iam_authentication=(value) ⇒ Object 



184
185
186
187
 
# File 'rds/database_instance.rb', line 184

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

#engine ⇒ AWSCDK::RDS::IInstanceEngine?

The engine of this database Instance.

May be not known for imported Instances if it wasn't provided explicitly, or for read replicas.

Returns:



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

def engine()
  jsii_get_property("engine")
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:



86
87
88
 
# File 'rds/database_instance.rb', line 86

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


305
306
307
 
# File 'rds/database_instance.rb', line 305

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


319
320
321
322
323
324
 
# File 'rds/database_instance.rb', line 319

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


334
335
336
337
 
# File 'rds/database_instance.rb', line 334

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

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

Grant the given identity connection access to the database.

[disable-awslint:no-grants]

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 db instance, or the default database user, obtained from the Secret, if not specified.

Returns:



365
366
367
368
369
 
# File 'rds/database_instance.rb', line 365

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

#instance_arn ⇒ String

The instance arn.

Returns:

  • (String) 


142
143
144
 
# File 'rds/database_instance.rb', line 142

def instance_arn()
  jsii_get_property("instanceArn")
end

#instance_endpoint ⇒ AWSCDK::RDS::Endpoint

The instance endpoint.

Returns:



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

def instance_endpoint()
  jsii_get_property("instanceEndpoint")
end

#instance_identifier ⇒ String

The instance identifier.

Returns:

  • (String) 


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

def instance_identifier()
  jsii_get_property("instanceIdentifier")
end

#instance_resource_id ⇒ String?

The AWS Region-unique, immutable identifier for the DB instance.

This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.

Returns:

  • (String, nil) 


175
176
177
 
# File 'rds/database_instance.rb', line 175

def instance_resource_id()
  jsii_get_property("instanceResourceId")
end

#instance_type ⇒ AWSCDK::EC2::InstanceType

Returns:



206
207
208
 
# File 'rds/database_instance.rb', line 206

def instance_type()
  jsii_get_property("instanceType")
end

#manage_master_user_password ⇒ Boolean?

Returns:

  • (Boolean, nil) 


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

def manage_master_user_password()
  jsii_get_property("manageMasterUserPassword")
end

#manage_master_user_password=(value) ⇒ Object 



244
245
246
247
 
# File 'rds/database_instance.rb', line 244

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

#metric(metric_name, props = nil) ⇒ AWSCDK::CloudWatch::Metric

Return the given named metric for this DBInstance.

Parameters:

Returns:



376
377
378
379
380
381
 
# File 'rds/database_instance.rb', line 376

def metric(metric_name, props = nil)
  Jsii::Type.check_type(metric_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metricName")
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metric", [metric_name, props])
end

#metric_cpu_utilization(props = nil) ⇒ AWSCDK::CloudWatch::Metric

The percentage of CPU utilization.

Average over 5 minutes

Parameters:

Returns:



389
390
391
392
393
 
# File 'rds/database_instance.rb', line 389

def metric_cpu_utilization(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricCPUUtilization", [props])
end

#metric_database_connections(props = nil) ⇒ AWSCDK::CloudWatch::Metric

The number of database connections in use.

Average over 5 minutes

Parameters:

Returns:



401
402
403
404
405
 
# File 'rds/database_instance.rb', line 401

def metric_database_connections(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricDatabaseConnections", [props])
end

#metric_free_storage_space(props = nil) ⇒ AWSCDK::CloudWatch::Metric

The amount of available storage space.

Average over 5 minutes

Parameters:

Returns:



425
426
427
428
429
 
# File 'rds/database_instance.rb', line 425

def metric_free_storage_space(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricFreeStorageSpace", [props])
end

#metric_freeable_memory(props = nil) ⇒ AWSCDK::CloudWatch::Metric

The amount of available random access memory.

Average over 5 minutes

Parameters:

Returns:



413
414
415
416
417
 
# File 'rds/database_instance.rb', line 413

def metric_freeable_memory(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricFreeableMemory", [props])
end

#metric_read_iops(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: - average over 5 minutes

The average number of disk read I/O operations per second. The average number of disk write I/O operations per second.

Average over 5 minutes

Parameters:

Returns:



438
439
440
441
442
 
# File 'rds/database_instance.rb', line 438

def metric_read_iops(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricReadIOPS", [props])
end

#metric_write_iops(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: - average over 5 minutes

The average number of disk write I/O operations per second. The average number of disk read I/O operations per second.

Average over 5 minutes

Parameters:

Returns:



451
452
453
454
455
 
# File 'rds/database_instance.rb', line 451

def metric_write_iops(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricWriteIOPS", [props])
end

#new_cfn_props ⇒ AWSCDK::RDS::CfnDBInstanceProps

Returns:



211
212
213
 
# File 'rds/database_instance.rb', line 211

def new_cfn_props()
  jsii_get_property("newCfnProps")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


71
72
73
 
# File 'rds/database_instance.rb', line 71

def node()
  jsii_get_property("node")
end

#on_event(id, options = nil) ⇒ AWSCDK::Events::Rule

Defines a CloudWatch event rule which triggers for instance events.

Use rule.addEventPattern(pattern) to specify a filter.

Parameters:

Returns:



465
466
467
468
469
470
 
# File 'rds/database_instance.rb', line 465

def on_event(id, options = nil)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  options = options.is_a?(Hash) ? ::AWSCDK::Events::OnEventOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZXZlbnRzLk9uRXZlbnRPcHRpb25zIn0=")), "options") unless options.nil?
  jsii_call_method("onEvent", [id, options])
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


100
101
102
 
# File 'rds/database_instance.rb', line 100

def physical_name()
  jsii_get_property("physicalName")
end

#secret ⇒ AWSCDK::SecretsManager::ISecret?

The AWS Secrets Manager secret attached to the instance.

Returns:



230
231
232
 
# File 'rds/database_instance.rb', line 230

def secret()
  jsii_get_property("secret")
end

#set_log_retention ⇒ void

This method returns an undefined value.



495
496
497
 
# File 'rds/database_instance.rb', line 495

def set_log_retention()
  jsii_call_method("setLogRetention", [])
end

#source_cfn_props ⇒ AWSCDK::RDS::CfnDBInstanceProps

Returns:



216
217
218
 
# File 'rds/database_instance.rb', line 216

def source_cfn_props()
  jsii_get_property("sourceCfnProps")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



107
108
109
 
# File 'rds/database_instance.rb', line 107

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


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

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

#vpc ⇒ AWSCDK::EC2::IVPC

The VPC where this database instance is deployed.

Returns:



223
224
225
 
# File 'rds/database_instance.rb', line 223

def vpc()
  jsii_get_property("vpc")
end

#vpc_placement ⇒ AWSCDK::EC2::SubnetSelection?

Returns:



235
236
237
 
# File 'rds/database_instance.rb', line 235

def vpc_placement()
  jsii_get_property("vpcPlacement")
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) 


265
266
267
268
269
270
 
# File 'rds/database_instance.rb', line 265

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