Class: AWSCDK::RDS::DatabaseInstanceReadReplica
- Inherits:
-
DatabaseInstanceBase
- Object
- DatabaseInstanceBase
- AWSCDK::RDS::DatabaseInstanceReadReplica
- Includes:
- IDatabaseInstance
- Defined in:
- rds/database_instance_read_replica.rb
Overview
A read replica database instance.
Class Method Summary collapse
- .jsii_overridable_methods ⇒ Object
-
.PROPERTY_INJECTION_ID ⇒ String
Uniquely identifies this class.
Instance Method Summary collapse
-
#add_proxy(id, options) ⇒ AWSCDK::RDS::DatabaseProxy
Add a new db proxy to this instance.
-
#apply_cross_stack_reference_strength(strength) ⇒ void
Override the cross-stack reference strength for this resource.
-
#apply_removal_policy(policy) ⇒ void
Apply the given removal policy to this resource.
-
#as_secret_attachment_target ⇒ AWSCDK::SecretsManager::SecretAttachmentTargetProps
Renders the secret attachment target specifications.
-
#cloudwatch_log_groups ⇒ Hash{String => AWSCDK::Logs::ILogGroup}
The log group is created when
cloudwatchLogsExportsis set. -
#connections ⇒ AWSCDK::EC2::Connections
Access to network connections.
-
#db_instance_endpoint_address ⇒ String
The instance endpoint address.
-
#db_instance_endpoint_port ⇒ String
The instance endpoint port.
-
#db_instance_ref ⇒ AWSCDK::Interfaces::AWSRDS::DBInstanceReference
A reference to this database instance.
- #enable_iam_authentication ⇒ Boolean?
- #enable_iam_authentication=(value) ⇒ Object
-
#engine ⇒ AWSCDK::RDS::IInstanceEngine?
The engine of this database Instance.
-
#env ⇒ AWSCDK::Interfaces::ResourceEnvironment
The environment this resource belongs to.
- #generate_physical_name ⇒ String
-
#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). -
#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). -
#grant_connect(grantee, db_user = nil) ⇒ AWSCDK::IAM::Grant
[disable-awslint:no-grants].
-
#initialize(scope, id, props) ⇒ DatabaseInstanceReadReplica
constructor
A new instance of DatabaseInstanceReadReplica.
-
#instance_arn ⇒ String
The instance arn.
-
#instance_endpoint ⇒ AWSCDK::RDS::Endpoint
The instance endpoint.
-
#instance_identifier ⇒ String
The instance identifier.
-
#instance_resource_id ⇒ String?
The AWS Region-unique, immutable identifier for the DB instance.
- #instance_type ⇒ AWSCDK::EC2::InstanceType
-
#metric(metric_name, props = nil) ⇒ AWSCDK::CloudWatch::Metric
Return the given named metric for this DBInstance.
-
#metric_cpu_utilization(props = nil) ⇒ AWSCDK::CloudWatch::Metric
The percentage of CPU utilization.
-
#metric_database_connections(props = nil) ⇒ AWSCDK::CloudWatch::Metric
The number of database connections in use.
-
#metric_free_storage_space(props = nil) ⇒ AWSCDK::CloudWatch::Metric
The amount of available storage space.
-
#metric_freeable_memory(props = nil) ⇒ AWSCDK::CloudWatch::Metric
The amount of available random access memory.
-
#metric_read_iops(props = nil) ⇒ AWSCDK::CloudWatch::Metric
The average number of disk read I/O operations per second.
-
#metric_write_iops(props = nil) ⇒ AWSCDK::CloudWatch::Metric
The average number of disk write I/O operations per second.
- #new_cfn_props ⇒ AWSCDK::RDS::CfnDBInstanceProps
-
#node ⇒ Constructs::Node
The tree node.
-
#on_event(id, options = nil) ⇒ AWSCDK::Events::Rule
Defines a CloudWatch event rule which triggers for instance events.
-
#physical_name ⇒ String
Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
- #set_log_retention ⇒ void
-
#stack ⇒ AWSCDK::Stack
The stack in which this resource is defined.
-
#to_string ⇒ String
Returns a string representation of this construct.
-
#vpc ⇒ AWSCDK::EC2::IVPC
The VPC where this database instance is deployed.
- #vpc_placement ⇒ AWSCDK::EC2::SubnetSelection?
-
#with(*mixins) ⇒ Constructs::IConstruct
Applies one or more mixins to this construct.
Constructor Details
#initialize(scope, id, props) ⇒ DatabaseInstanceReadReplica
Returns a new instance of DatabaseInstanceReadReplica.
12 13 14 15 16 17 18 |
# File 'rds/database_instance_read_replica.rb', line 12 def initialize(scope, id, props) props = props.is_a?(Hash) ? ::AWSCDK::RDS::DatabaseInstanceReadReplicaProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmRzLkRhdGFiYXNlSW5zdGFuY2VSZWFkUmVwbGljYVByb3BzIn0=")), "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 |
# File 'rds/database_instance_read_replica.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 }, :vpc => { kind: :property, name: "vpc", is_optional: false }, :vpc_placement => { kind: :property, name: "vpcPlacement", 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 }, :set_log_retention => { kind: :method, name: "setLogRetention", is_optional: false }, } end |
.PROPERTY_INJECTION_ID ⇒ String
Uniquely identifies this class.
188 189 190 |
# File 'rds/database_instance_read_replica.rb', line 188 def self.PROPERTY_INJECTION_ID() Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_rds.DatabaseInstanceReadReplica", "PROPERTY_INJECTION_ID") end |
Instance Method Details
#add_proxy(id, options) ⇒ AWSCDK::RDS::DatabaseProxy
Add a new db proxy to this instance.
318 319 320 321 322 323 |
# File 'rds/database_instance_read_replica.rb', line 318 def add_proxy(id, ) Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id") = .is_a?(Hash) ? ::AWSCDK::RDS::DatabaseProxyOptions.new(**.transform_keys(&:to_sym)) : Jsii::Type.check_type(, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmRzLkRhdGFiYXNlUHJveHlPcHRpb25zIn0=")), "options") jsii_call_method("addProxy", [id, ]) 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.
256 257 258 259 |
# File 'rds/database_instance_read_replica.rb', line 256 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).
273 274 275 276 |
# File 'rds/database_instance_read_replica.rb', line 273 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.
328 329 330 |
# File 'rds/database_instance_read_replica.rb', line 328 def () 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.
197 198 199 |
# File 'rds/database_instance_read_replica.rb', line 197 def cloudwatch_log_groups() jsii_get_property("cloudwatchLogGroups") end |
#connections ⇒ AWSCDK::EC2::Connections
Access to network connections.
109 110 111 |
# File 'rds/database_instance_read_replica.rb', line 109 def connections() jsii_get_property("connections") end |
#db_instance_endpoint_address ⇒ String
The instance endpoint address.
116 117 118 |
# File 'rds/database_instance_read_replica.rb', line 116 def db_instance_endpoint_address() jsii_get_property("dbInstanceEndpointAddress") end |
#db_instance_endpoint_port ⇒ String
The instance endpoint port.
123 124 125 |
# File 'rds/database_instance_read_replica.rb', line 123 def db_instance_endpoint_port() jsii_get_property("dbInstanceEndpointPort") end |
#db_instance_ref ⇒ AWSCDK::Interfaces::AWSRDS::DBInstanceReference
A reference to this database instance.
130 131 132 |
# File 'rds/database_instance_read_replica.rb', line 130 def db_instance_ref() jsii_get_property("dbInstanceRef") end |
#enable_iam_authentication ⇒ Boolean?
176 177 178 |
# File 'rds/database_instance_read_replica.rb', line 176 def enable_iam_authentication() jsii_get_property("enableIamAuthentication") end |
#enable_iam_authentication=(value) ⇒ Object
180 181 182 183 |
# File 'rds/database_instance_read_replica.rb', line 180 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.
161 162 163 |
# File 'rds/database_instance_read_replica.rb', line 161 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.
81 82 83 |
# File 'rds/database_instance_read_replica.rb', line 81 def env() jsii_get_property("env") end |
#generate_physical_name ⇒ String
279 280 281 |
# File 'rds/database_instance_read_replica.rb', line 279 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.
293 294 295 296 297 298 |
# File 'rds/database_instance_read_replica.rb', line 293 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.
308 309 310 311 |
# File 'rds/database_instance_read_replica.rb', line 308 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
[disable-awslint:no-grants].
337 338 339 340 341 |
# File 'rds/database_instance_read_replica.rb', line 337 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.
137 138 139 |
# File 'rds/database_instance_read_replica.rb', line 137 def instance_arn() jsii_get_property("instanceArn") end |
#instance_endpoint ⇒ AWSCDK::RDS::Endpoint
The instance endpoint.
144 145 146 |
# File 'rds/database_instance_read_replica.rb', line 144 def instance_endpoint() jsii_get_property("instanceEndpoint") end |
#instance_identifier ⇒ String
The instance identifier.
151 152 153 |
# File 'rds/database_instance_read_replica.rb', line 151 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.
171 172 173 |
# File 'rds/database_instance_read_replica.rb', line 171 def instance_resource_id() jsii_get_property("instanceResourceId") end |
#instance_type ⇒ AWSCDK::EC2::InstanceType
202 203 204 |
# File 'rds/database_instance_read_replica.rb', line 202 def instance_type() jsii_get_property("instanceType") end |
#metric(metric_name, props = nil) ⇒ AWSCDK::CloudWatch::Metric
Return the given named metric for this DBInstance.
348 349 350 351 352 353 |
# File 'rds/database_instance_read_replica.rb', line 348 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
361 362 363 364 365 |
# File 'rds/database_instance_read_replica.rb', line 361 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
373 374 375 376 377 |
# File 'rds/database_instance_read_replica.rb', line 373 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
397 398 399 400 401 |
# File 'rds/database_instance_read_replica.rb', line 397 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
385 386 387 388 389 |
# File 'rds/database_instance_read_replica.rb', line 385 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
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
410 411 412 413 414 |
# File 'rds/database_instance_read_replica.rb', line 410 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
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
423 424 425 426 427 |
# File 'rds/database_instance_read_replica.rb', line 423 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
207 208 209 |
# File 'rds/database_instance_read_replica.rb', line 207 def new_cfn_props() jsii_get_property("newCfnProps") end |
#node ⇒ Constructs::Node
The tree node.
66 67 68 |
# File 'rds/database_instance_read_replica.rb', line 66 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.
437 438 439 440 441 442 |
# File 'rds/database_instance_read_replica.rb', line 437 def on_event(id, = nil) Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id") = .is_a?(Hash) ? ::AWSCDK::Events::OnEventOptions.new(**.transform_keys(&:to_sym)) : Jsii::Type.check_type(, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZXZlbnRzLk9uRXZlbnRPcHRpb25zIn0=")), "options") unless .nil? jsii_call_method("onEvent", [id, ]) 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.
95 96 97 |
# File 'rds/database_instance_read_replica.rb', line 95 def physical_name() jsii_get_property("physicalName") end |
#set_log_retention ⇒ void
This method returns an undefined value.
445 446 447 |
# File 'rds/database_instance_read_replica.rb', line 445 def set_log_retention() jsii_call_method("setLogRetention", []) end |
#stack ⇒ AWSCDK::Stack
The stack in which this resource is defined.
102 103 104 |
# File 'rds/database_instance_read_replica.rb', line 102 def stack() jsii_get_property("stack") end |
#to_string ⇒ String
Returns a string representation of this construct.
226 227 228 |
# File 'rds/database_instance_read_replica.rb', line 226 def to_string() jsii_call_method("toString", []) end |
#vpc ⇒ AWSCDK::EC2::IVPC
The VPC where this database instance is deployed.
214 215 216 |
# File 'rds/database_instance_read_replica.rb', line 214 def vpc() jsii_get_property("vpc") end |
#vpc_placement ⇒ AWSCDK::EC2::SubnetSelection?
219 220 221 |
# File 'rds/database_instance_read_replica.rb', line 219 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.
239 240 241 242 243 244 |
# File 'rds/database_instance_read_replica.rb', line 239 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 |