Class IDatabaseInstance.Jsii$Proxy
- All Implemented Interfaces:
IConstruct
,IConstruct.Jsii$Default
,IDependable
,IDependable.Jsii$Default
,IResource
,IResource.Jsii$Default
,IConnectable
,IConnectable.Jsii$Default
,IDatabaseInstance
,IDatabaseInstance.Jsii$Default
,ISecretAttachmentTarget
,ISecretAttachmentTarget.Jsii$Default
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IConstruct.Jsii$Default
- Enclosing interface:
- IDatabaseInstance
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.IConnectable
IConnectable.Jsii$Default, IConnectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default, IConstruct.Jsii$Proxy
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.rds.IDatabaseInstance
IDatabaseInstance.Jsii$Default, IDatabaseInstance.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IDependable
IDependable.Jsii$Default, IDependable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource
IResource.Jsii$Default, IResource.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.secretsmanager.ISecretAttachmentTarget
ISecretAttachmentTarget.Jsii$Default, ISecretAttachmentTarget.Jsii$Proxy
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal DatabaseProxy
addProxy
(String id, DatabaseProxyOptions options) Add a new db proxy to this instance.final void
applyRemovalPolicy
(RemovalPolicy policy) Apply the given removal policy to this resource.Renders the target specifications.final Connections
The network connections associated with this resource.final String
The instance endpoint address.final String
The instance endpoint port.final IInstanceEngine
The engine of this database Instance.final ResourceEnvironment
getEnv()
The environment this resource belongs to.final String
The instance arn.final Endpoint
The instance endpoint.final String
The instance identifier.final ConstructNode
getNode()
The construct tree node for this construct.final Stack
getStack()
The stack in which this resource is defined.final Grant
grantConnect
(IGrantable grantee) Grant the given identity connection access to the database.final Metric
Return the given named metric for this DBInstance.final Metric
metric
(String metricName, MetricOptions props) Return the given named metric for this DBInstance.final Metric
The percentage of CPU utilization.final Metric
The percentage of CPU utilization.final Metric
The number of database connections in use.final Metric
The number of database connections in use.final Metric
The amount of available random access memory.final Metric
The amount of available random access memory.final Metric
The amount of available storage space.final Metric
The amount of available storage space.final Metric
The average number of disk write I/O operations per second.final Metric
metricReadIOPS
(MetricOptions props) The average number of disk write I/O operations per second.final Metric
The average number of disk read I/O operations per second.final Metric
metricWriteIOPS
(MetricOptions props) The average number of disk read I/O operations per second.final Rule
Defines a CloudWatch event rule which triggers for instance events.final Rule
onEvent
(String id, OnEventOptions options) Defines a CloudWatch event rule which triggers for instance events.Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
-
-
Method Details
-
getNode
The construct tree node for this construct.- Specified by:
getNode
in interfaceIConstruct
- Specified by:
getNode
in interfaceIConstruct.Jsii$Default
- Specified by:
getNode
in interfaceIDatabaseInstance.Jsii$Default
- Specified by:
getNode
in interfaceIResource.Jsii$Default
-
getEnv
The environment this resource belongs to.For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
- Specified by:
getEnv
in interfaceIDatabaseInstance.Jsii$Default
- Specified by:
getEnv
in interfaceIResource
- Specified by:
getEnv
in interfaceIResource.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStack
in interfaceIDatabaseInstance.Jsii$Default
- Specified by:
getStack
in interfaceIResource
- Specified by:
getStack
in interfaceIResource.Jsii$Default
-
getConnections
The network connections associated with this resource.- Specified by:
getConnections
in interfaceIConnectable
- Specified by:
getConnections
in interfaceIConnectable.Jsii$Default
- Specified by:
getConnections
in interfaceIDatabaseInstance.Jsii$Default
-
getDbInstanceEndpointAddress
The instance endpoint address.- Specified by:
getDbInstanceEndpointAddress
in interfaceIDatabaseInstance
- Specified by:
getDbInstanceEndpointAddress
in interfaceIDatabaseInstance.Jsii$Default
-
getDbInstanceEndpointPort
The instance endpoint port.- Specified by:
getDbInstanceEndpointPort
in interfaceIDatabaseInstance
- Specified by:
getDbInstanceEndpointPort
in interfaceIDatabaseInstance.Jsii$Default
-
getInstanceArn
The instance arn.- Specified by:
getInstanceArn
in interfaceIDatabaseInstance
- Specified by:
getInstanceArn
in interfaceIDatabaseInstance.Jsii$Default
-
getInstanceEndpoint
The instance endpoint.- Specified by:
getInstanceEndpoint
in interfaceIDatabaseInstance
- Specified by:
getInstanceEndpoint
in interfaceIDatabaseInstance.Jsii$Default
-
getInstanceIdentifier
The instance identifier.- Specified by:
getInstanceIdentifier
in interfaceIDatabaseInstance
- Specified by:
getInstanceIdentifier
in interfaceIDatabaseInstance.Jsii$Default
-
getEngine
The engine of this database Instance.May be not known for imported Instances if it wasn't provided explicitly, or for read replicas.
- Specified by:
getEngine
in interfaceIDatabaseInstance
- Specified by:
getEngine
in interfaceIDatabaseInstance.Jsii$Default
-
applyRemovalPolicy
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
).- Specified by:
applyRemovalPolicy
in interfaceIDatabaseInstance.Jsii$Default
- Specified by:
applyRemovalPolicy
in interfaceIResource
- Specified by:
applyRemovalPolicy
in interfaceIResource.Jsii$Default
- Parameters:
policy
- This parameter is required.
-
asSecretAttachmentTarget
Renders the target specifications.- Specified by:
asSecretAttachmentTarget
in interfaceIDatabaseInstance.Jsii$Default
- Specified by:
asSecretAttachmentTarget
in interfaceISecretAttachmentTarget
- Specified by:
asSecretAttachmentTarget
in interfaceISecretAttachmentTarget.Jsii$Default
-
addProxy
@Stability(Stable) @NotNull public final DatabaseProxy addProxy(@NotNull String id, @NotNull DatabaseProxyOptions options) Add a new db proxy to this instance.- Specified by:
addProxy
in interfaceIDatabaseInstance
- Specified by:
addProxy
in interfaceIDatabaseInstance.Jsii$Default
- Parameters:
id
- This parameter is required.options
- This parameter is required.
-
grantConnect
Grant the given identity connection access to the database.Note: this method does not currently work, see https://github.com/aws/aws-cdk/issues/11851 for details.
- Specified by:
grantConnect
in interfaceIDatabaseInstance
- Specified by:
grantConnect
in interfaceIDatabaseInstance.Jsii$Default
- Parameters:
grantee
- This parameter is required.- See Also:
-
metric
@Stability(Stable) @NotNull public final Metric metric(@NotNull String metricName, @Nullable MetricOptions props) Return the given named metric for this DBInstance.- Specified by:
metric
in interfaceIDatabaseInstance
- Specified by:
metric
in interfaceIDatabaseInstance.Jsii$Default
- Parameters:
metricName
- This parameter is required.props
-
-
metric
Return the given named metric for this DBInstance.- Specified by:
metric
in interfaceIDatabaseInstance
- Parameters:
metricName
- This parameter is required.
-
metricCPUUtilization
The percentage of CPU utilization.Average over 5 minutes
- Specified by:
metricCPUUtilization
in interfaceIDatabaseInstance
- Specified by:
metricCPUUtilization
in interfaceIDatabaseInstance.Jsii$Default
- Parameters:
props
-
-
metricCPUUtilization
The percentage of CPU utilization.Average over 5 minutes
- Specified by:
metricCPUUtilization
in interfaceIDatabaseInstance
-
metricDatabaseConnections
@Stability(Stable) @NotNull public final Metric metricDatabaseConnections(@Nullable MetricOptions props) The number of database connections in use.Average over 5 minutes
- Specified by:
metricDatabaseConnections
in interfaceIDatabaseInstance
- Specified by:
metricDatabaseConnections
in interfaceIDatabaseInstance.Jsii$Default
- Parameters:
props
-
-
metricDatabaseConnections
The number of database connections in use.Average over 5 minutes
- Specified by:
metricDatabaseConnections
in interfaceIDatabaseInstance
-
metricFreeableMemory
The amount of available random access memory.Average over 5 minutes
- Specified by:
metricFreeableMemory
in interfaceIDatabaseInstance
- Specified by:
metricFreeableMemory
in interfaceIDatabaseInstance.Jsii$Default
- Parameters:
props
-
-
metricFreeableMemory
The amount of available random access memory.Average over 5 minutes
- Specified by:
metricFreeableMemory
in interfaceIDatabaseInstance
-
metricFreeStorageSpace
@Stability(Stable) @NotNull public final Metric metricFreeStorageSpace(@Nullable MetricOptions props) The amount of available storage space.Average over 5 minutes
- Specified by:
metricFreeStorageSpace
in interfaceIDatabaseInstance
- Specified by:
metricFreeStorageSpace
in interfaceIDatabaseInstance.Jsii$Default
- Parameters:
props
-
-
metricFreeStorageSpace
The amount of available storage space.Average over 5 minutes
- Specified by:
metricFreeStorageSpace
in interfaceIDatabaseInstance
-
metricReadIOPS
The average number of disk write I/O operations per second.Average over 5 minutes
- Specified by:
metricReadIOPS
in interfaceIDatabaseInstance
- Specified by:
metricReadIOPS
in interfaceIDatabaseInstance.Jsii$Default
- Parameters:
props
-
-
metricReadIOPS
The average number of disk write I/O operations per second.Average over 5 minutes
- Specified by:
metricReadIOPS
in interfaceIDatabaseInstance
-
metricWriteIOPS
The average number of disk read I/O operations per second.Average over 5 minutes
- Specified by:
metricWriteIOPS
in interfaceIDatabaseInstance
- Specified by:
metricWriteIOPS
in interfaceIDatabaseInstance.Jsii$Default
- Parameters:
props
-
-
metricWriteIOPS
The average number of disk read I/O operations per second.Average over 5 minutes
- Specified by:
metricWriteIOPS
in interfaceIDatabaseInstance
-
onEvent
@Stability(Stable) @NotNull public final Rule onEvent(@NotNull String id, @Nullable OnEventOptions options) Defines a CloudWatch event rule which triggers for instance events.Use
rule.addEventPattern(pattern)
to specify a filter.- Specified by:
onEvent
in interfaceIDatabaseInstance
- Specified by:
onEvent
in interfaceIDatabaseInstance.Jsii$Default
- Parameters:
id
- This parameter is required.options
-
-
onEvent
Defines a CloudWatch event rule which triggers for instance events.Use
rule.addEventPattern(pattern)
to specify a filter.- Specified by:
onEvent
in interfaceIDatabaseInstance
- Parameters:
id
- This parameter is required.
-