class DatabaseClusterFromSnapshot (construct)
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.RDS.DatabaseClusterFromSnapshot |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsrds#DatabaseClusterFromSnapshot |
Java | software.amazon.awscdk.services.rds.DatabaseClusterFromSnapshot |
Python | aws_cdk.aws_rds.DatabaseClusterFromSnapshot |
TypeScript (source) | aws-cdk-lib » aws_rds » DatabaseClusterFromSnapshot |
Implements
IConstruct
, IDependable
, IResource
, IDatabase
, IConnectable
, ISecret
A database cluster restored from a snapshot.
Example
declare const vpc: ec2.Vpc;
new rds.DatabaseClusterFromSnapshot(this, 'Database', {
engine: rds.DatabaseClusterEngine.aurora({ version: rds.AuroraEngineVersion.VER_1_22_2 }),
writer: rds.ClusterInstance.provisioned('writer'),
vpc,
snapshotIdentifier: 'mySnapshot',
});
Initializer
new DatabaseClusterFromSnapshot(scope: Construct, id: string, props: DatabaseClusterFromSnapshotProps)
Parameters
- scope
Construct
- id
string
- props
Database
Cluster From Snapshot Props
Construct Props
Name | Type | Description |
---|---|---|
engine | ICluster | What kind of database to start. |
snapshot | string | The identifier for the DB instance snapshot or DB cluster snapshot to restore from. |
auto | boolean | Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. |
backtrack | Duration | The number of seconds to set a cluster's target backtrack window to. |
backup? | Backup | Backup settings. |
cloudwatch | string[] | The list of log types that need to be enabled for exporting to CloudWatch Logs. |
cloudwatch | Retention | The number of days log events are kept in CloudWatch Logs. |
cloudwatch | IRole | The IAM role for the Lambda function associated with the custom resource that sets the retention policy. |
cluster | string | An optional identifier for the cluster. |
cluster | Cluster | Specifies the scalability mode of the Aurora DB cluster. |
copy | boolean | Whether to copy tags to the snapshot when a snapshot is created. |
credentials? | Credentials | Credentials for the administrative user. |
default | string | Name of a database which is automatically created inside the cluster. |
deletion | boolean | Indicates whether the DB cluster should have deletion protection enabled. |
domain? | string | Directory ID for associating the DB cluster with a specific Active Directory. |
domain | IRole | The IAM role to be used when making API calls to the Directory Service. |
enable | boolean | Whether to enable enhanced monitoring at the cluster level. |
enable | boolean | Whether to enable the Data API for the cluster. |
enable | boolean | Whether read replicas can forward write operations to the writer DB instance in the DB cluster. |
enable | boolean | Whether to enable Performance Insights for the DB cluster. |
iam | boolean | Whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. |
instance | string | Base identifier for instances. |
instance | Instance | Settings for the individual instances that are launched. |
instance | Instance | The ordering of updates for instances. |
instances? | number | How many replicas/instances to create. |
monitoring | Duration | The interval between points when Amazon RDS collects enhanced monitoring metrics. |
monitoring | IRole | Role that will be used to manage DB monitoring. |
network | Network | The network type of the DB instance. |
parameter | IParameter | Additional parameters to pass to the database engine. |
parameters? | { [string]: string } | The parameters in the DBClusterParameterGroup to create automatically. |
performance | IKey | The AWS KMS key for encryption of Performance Insights data. |
performance | Performance | The amount of time, in days, to retain Performance Insights data. |
port? | number | What port to listen on. |
preferred | string | A preferred maintenance window day/time range. Should be specified as a range ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). |
readers? | ICluster [] | A list of instances to create as cluster reader instances. |
removal | Removal | The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update. |
s3 | IBucket [] | S3 buckets that you want to load data into. This feature is only supported by the Aurora database engine. |
s3 | IRole | Role that will be associated with this DB cluster to enable S3 export. |
s3 | IBucket [] | S3 buckets that you want to load data from. This feature is only supported by the Aurora database engine. |
s3 | IRole | Role that will be associated with this DB cluster to enable S3 import. |
security | ISecurity [] | Security group. |
serverless | number | The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. |
serverless | number | The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. |
snapshot | Snapshot | Master user credentials. |
storage | boolean | Whether to enable storage encryption. |
storage | IKey | The KMS key for storage encryption. |
storage | DBCluster | The storage type to be associated with the DB cluster. |
subnet | ISubnet | Existing subnet group for the cluster. |
vpc? | IVpc | What subnets to run the RDS instances in. |
vpc | Subnet | Where to place the instances within the VPC. |
writer? | ICluster | The instance to use for the cluster writer. |
engine
Type:
ICluster
What kind of database to start.
snapshotIdentifier
Type:
string
The identifier for the DB instance snapshot or DB cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB instance snapshot.
autoMinorVersionUpgrade?
Type:
boolean
(optional, default: true)
Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.
backtrackWindow?
Type:
Duration
(optional, default: 0 seconds (no backtrack))
The number of seconds to set a cluster's target backtrack window to.
This feature is only supported by the Aurora MySQL database engine and cannot be enabled on existing clusters.
backup?
Type:
Backup
(optional, default: Backup retention period for automated backups is 1 day.
Backup preferred window is set to a 30-minute window selected at random from an
8-hour block of time for each AWS Region, occurring on a random day of the week.)
Backup settings.
cloudwatchLogsExports?
Type:
string[]
(optional, default: no log exports)
The list of log types that need to be enabled for exporting to CloudWatch Logs.
cloudwatchLogsRetention?
Type:
Retention
(optional, default: logs never expire)
The number of days log events are kept in CloudWatch Logs.
When updating
this property, unsetting it doesn't remove the log retention policy. To
remove the retention policy, set the value to Infinity
.
cloudwatchLogsRetentionRole?
Type:
IRole
(optional, default: a new role is created.)
The IAM role for the Lambda function associated with the custom resource that sets the retention policy.
clusterIdentifier?
Type:
string
(optional, default: A name is automatically generated.)
An optional identifier for the cluster.
clusterScailabilityType?
Type:
Cluster
(optional, default: ClusterScailabilityType.STANDARD)
Specifies the scalability mode of the Aurora DB cluster.
Set LIMITLESS if you want to use a limitless database; otherwise, set it to STANDARD.
copyTagsToSnapshot?
Type:
boolean
(optional, default: true)
Whether to copy tags to the snapshot when a snapshot is created.
credentials?
⚠️ Deprecated: use snapshotCredentials
which allows to generate a new password
Type:
Credentials
(optional, default: A username of 'admin' (or 'postgres' for PostgreSQL) and SecretsManager-generated password
that will not be applied to the cluster, use snapshotCredentials
for the correct behavior.)
Credentials for the administrative user.
Note - using this prop only works with Credentials.fromPassword()
with the
username of the snapshot, Credentials.fromUsername()
with the username and
password of the snapshot or Credentials.fromSecret()
with a secret containing
the username and password of the snapshot.
defaultDatabaseName?
Type:
string
(optional, default: Database is not created in cluster.)
Name of a database which is automatically created inside the cluster.
deletionProtection?
Type:
boolean
(optional, default: true if removalPolicy
is RETAIN, undefined
otherwise, which will not enable deletion protection.
To disable deletion protection after it has been enabled, you must explicitly set this value to false
.)
Indicates whether the DB cluster should have deletion protection enabled.
domain?
Type:
string
(optional, default: DB cluster is not associated with an Active Directory; Kerberos authentication is not enabled.)
Directory ID for associating the DB cluster with a specific Active Directory.
Necessary for enabling Kerberos authentication. If specified, the DB cluster joins the given Active Directory, enabling Kerberos authentication. If not specified, the DB cluster will not be associated with any Active Directory, and Kerberos authentication will not be enabled.
domainRole?
Type:
IRole
(optional, default: If DatabaseClusterBaseProps.domain
is specified, a role with the AmazonRDSDirectoryServiceAccess
policy is automatically created.)
The IAM role to be used when making API calls to the Directory Service.
The role needs the AWS-managed policy
AmazonRDSDirectoryServiceAccess
or equivalent.
enableClusterLevelEnhancedMonitoring?
Type:
boolean
(optional, default: When the monitoringInterval
is set, enhanced monitoring is enabled for each instance.)
Whether to enable enhanced monitoring at the cluster level.
If set to true, monitoringInterval
and monitoringRole
are applied to not the instances, but the cluster.
monitoringInterval
is required to be set if enableClusterLevelEnhancedMonitoring
is set to true.
enableDataApi?
Type:
boolean
(optional, default: false)
Whether to enable the Data API for the cluster.
enableLocalWriteForwarding?
Type:
boolean
(optional, default: false)
Whether read replicas can forward write operations to the writer DB instance in the DB cluster.
This setting can only be enabled for Aurora MySQL 3.04 or higher, and for Aurora PostgreSQL 16.4 or higher (for version 16), 15.8 or higher (for version 15), and 14.13 or higher (for version 14).
enablePerformanceInsights?
Type:
boolean
(optional, default: false, unless performanceInsightRetention
or performanceInsightEncryptionKey
is set.)
Whether to enable Performance Insights for the DB cluster.
iamAuthentication?
Type:
boolean
(optional, default: false)
Whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
instanceIdentifierBase?
Type:
string
(optional, default: clusterIdentifier is used with the word "Instance" appended.
If clusterIdentifier is not provided, the identifier is automatically generated.)
Base identifier for instances.
Every replica is named by appending the replica number to this string, 1-based.
instanceProps?
⚠️ Deprecated: - use writer and readers instead
Type:
Instance
(optional)
Settings for the individual instances that are launched.
instanceUpdateBehaviour?
Type:
Instance
(optional, default: InstanceUpdateBehaviour.BULK)
The ordering of updates for instances.
instances?
⚠️ Deprecated: - use writer and readers instead
Type:
number
(optional, default: 2)
How many replicas/instances to create.
Has to be at least 1.
monitoringInterval?
Type:
Duration
(optional, default: no enhanced monitoring)
The interval between points when Amazon RDS collects enhanced monitoring metrics.
If you enable enableClusterLevelEnhancedMonitoring
, this property is applied to the cluster,
otherwise it is applied to the instances.
monitoringRole?
Type:
IRole
(optional, default: A role is automatically created for you)
Role that will be used to manage DB monitoring.
If you enable enableClusterLevelEnhancedMonitoring
, this property is applied to the cluster,
otherwise it is applied to the instances.
networkType?
Type:
Network
(optional, default: IPV4)
The network type of the DB instance.
parameterGroup?
Type:
IParameter
(optional, default: No parameter group.)
Additional parameters to pass to the database engine.
parameters?
Type:
{ [string]: string }
(optional, default: None)
The parameters in the DBClusterParameterGroup to create automatically.
You can only specify parameterGroup or parameters but not both. You need to use a versioned engine to auto-generate a DBClusterParameterGroup.
performanceInsightEncryptionKey?
Type:
IKey
(optional, default: default master key)
The AWS KMS key for encryption of Performance Insights data.
performanceInsightRetention?
Type:
Performance
(optional, default: 7)
The amount of time, in days, to retain Performance Insights data.
port?
Type:
number
(optional, default: The default for the engine is used.)
What port to listen on.
preferredMaintenanceWindow?
Type:
string
(optional, default: 30-minute window selected at random from an 8-hour block of time for
each AWS Region, occurring on a random day of the week.)
A preferred maintenance window day/time range. Should be specified as a range ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC).
Example: 'Sun:23:45-Mon:00:15'
readers?
Type:
ICluster
[]
(optional, default: no readers are created. The cluster will have a single writer/reader)
A list of instances to create as cluster reader instances.
removalPolicy?
Type:
Removal
(optional, default: RemovalPolicy.SNAPSHOT (remove the cluster and instances, but retain a snapshot of the data))
The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update.
s3ExportBuckets?
Type:
IBucket
[]
(optional, default: None)
S3 buckets that you want to load data into. This feature is only supported by the Aurora database engine.
This property must not be used if s3ExportRole
is used.
For MySQL:
s3ExportRole?
Type:
IRole
(optional, default: New role is created if s3ExportBuckets
is set, no role is defined otherwise)
Role that will be associated with this DB cluster to enable S3 export.
This feature is only supported by the Aurora database engine.
This property must not be used if s3ExportBuckets
is used.
To use this property with Aurora PostgreSQL, it must be configured with the S3 export feature enabled when creating the DatabaseClusterEngine
For MySQL:
s3ImportBuckets?
Type:
IBucket
[]
(optional, default: None)
S3 buckets that you want to load data from. This feature is only supported by the Aurora database engine.
This property must not be used if s3ImportRole
is used.
For MySQL:
s3ImportRole?
Type:
IRole
(optional, default: New role is created if s3ImportBuckets
is set, no role is defined otherwise)
Role that will be associated with this DB cluster to enable S3 import.
This feature is only supported by the Aurora database engine.
This property must not be used if s3ImportBuckets
is used.
To use this property with Aurora PostgreSQL, it must be configured with the S3 import feature enabled when creating the DatabaseClusterEngine
For MySQL:
securityGroups?
Type:
ISecurity
[]
(optional, default: a new security group is created.)
Security group.
serverlessV2MaxCapacity?
Type:
number
(optional, default: 2)
The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.
You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 256.
The maximum capacity must be higher than 0.5 ACUs.
serverlessV2MinCapacity?
Type:
number
(optional, default: 0.5)
The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.
You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.
For Aurora versions that support the Aurora Serverless v2 auto-pause feature, the smallest value that you can use is 0. For versions that don't support Aurora Serverless v2 auto-pause, the smallest value that you can use is 0.5.
snapshotCredentials?
Type:
Snapshot
(optional, default: The existing username and password from the snapshot will be used.)
Master user credentials.
Note - It is not possible to change the master username for a snapshot; however, it is possible to provide (or generate) a new password.
storageEncrypted?
Type:
boolean
(optional, default: true if storageEncryptionKey is provided, false otherwise)
Whether to enable storage encryption.
storageEncryptionKey?
Type:
IKey
(optional, default: if storageEncrypted is true then the default master key, no key otherwise)
The KMS key for storage encryption.
If specified, storageEncrypted
will be set to true
.
storageType?
Type:
DBCluster
(optional, default: DBClusterStorageType.AURORA_IOPT1)
The storage type to be associated with the DB cluster.
subnetGroup?
Type:
ISubnet
(optional, default: a new subnet group will be created.)
Existing subnet group for the cluster.
vpc?
Type:
IVpc
(optional)
What subnets to run the RDS instances in.
Must be at least 2 subnets in two different AZs.
vpcSubnets?
Type:
Subnet
(optional, default: the Vpc default strategy if not specified.)
Where to place the instances within the VPC.
writer?
Type:
ICluster
(optional, default: required if instanceProps is not provided)
The instance to use for the cluster writer.
Properties
Name | Type | Description |
---|---|---|
cloudwatch | { [string]: ILog } | The log group is created when cloudwatchLogsExports is set. |
cluster | string | The ARN of the cluster. |
cluster | Endpoint | The endpoint to use for read/write operations. |
cluster | string | Identifier of the cluster. |
cluster | Endpoint | Endpoint to use for load-balanced read-only operations. |
cluster | string | The immutable identifier for the cluster; for example: cluster-ABCD1234EFGH5678IJKL90MNOP. |
connections | Connections | Access to the network connections. |
env | Resource | The environment this resource belongs to. |
instance | Endpoint [] | Endpoints which address each individual replica. |
instance | string[] | Identifiers of the replicas. |
multi | Secret | Application for multi user rotation to this cluster. |
new | Cfn | |
node | Node | The tree node. |
performance | boolean | Whether Performance Insights is enabled at cluster level. |
security | ISecurity [] | |
serverless | number | |
serverless | number | |
single | Secret | Application for single user rotation of the master password to this cluster. |
stack | Stack | The stack in which this resource is defined. |
subnet | ISubnet | |
vpc | IVpc | The VPC network to place the cluster in. |
enable | boolean | |
engine? | ICluster | The engine for this Cluster. |
has | boolean | |
monitoring | IRole | The IAM role for the enhanced monitoring. |
performance | IKey | The AWS KMS key for encryption of Performance Insights data. |
performance | Performance | The amount of time, in days, to retain Performance Insights data. |
secret? | ISecret | The secret attached to this cluster. |
vpc | Subnet | The cluster's subnets. |
cloudwatchLogGroups
Type:
{ [string]:
ILog
}
The log group is created when cloudwatchLogsExports
is set.
Each export value will create a separate log group.
clusterArn
Type:
string
The ARN of the cluster.
clusterEndpoint
Type:
Endpoint
The endpoint to use for read/write operations.
clusterIdentifier
Type:
string
Identifier of the cluster.
clusterReadEndpoint
Type:
Endpoint
Endpoint to use for load-balanced read-only operations.
clusterResourceIdentifier
Type:
string
The immutable identifier for the cluster; for example: cluster-ABCD1234EFGH5678IJKL90MNOP.
This AWS Region-unique identifier is used in things like IAM authentication policies.
connections
Type:
Connections
Access to the network connections.
env
Type:
Resource
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.
instanceEndpoints
Type:
Endpoint
[]
Endpoints which address each individual replica.
instanceIdentifiers
Type:
string[]
Identifiers of the replicas.
multiUserRotationApplication
Type:
Secret
Application for multi user rotation to this cluster.
newCfnProps
Type:
Cfn
node
Type:
Node
The tree node.
performanceInsightsEnabled
Type:
boolean
Whether Performance Insights is enabled at cluster level.
securityGroups
Type:
ISecurity
[]
serverlessV2MaxCapacity
Type:
number
serverlessV2MinCapacity
Type:
number
singleUserRotationApplication
Type:
Secret
Application for single user rotation of the master password to this cluster.
stack
Type:
Stack
The stack in which this resource is defined.
subnetGroup
Type:
ISubnet
vpc
Type:
IVpc
The VPC network to place the cluster in.
enableDataApi?
Type:
boolean
(optional)
engine?
Type:
ICluster
(optional)
The engine for this Cluster.
Never undefined.
hasServerlessInstance?
Type:
boolean
(optional)
monitoringRole?
Type:
IRole
(optional)
The IAM role for the enhanced monitoring.
performanceInsightEncryptionKey?
Type:
IKey
(optional)
The AWS KMS key for encryption of Performance Insights data.
performanceInsightRetention?
Type:
Performance
(optional)
The amount of time, in days, to retain Performance Insights data.
secret?
Type:
ISecret
(optional)
The secret attached to this cluster.
vpcSubnets?
Type:
Subnet
(optional)
The cluster's subnets.
Methods
Name | Description |
---|---|
add | Add a new db proxy to this cluster. |
add | Adds the multi user rotation to this cluster. |
add | Adds the single user rotation of the master password to this cluster. |
apply | Apply the given removal policy to this resource. |
as | Renders the secret attachment target specifications. |
grant | Grant the given identity connection access to the Cluster. |
grant | Grant the given identity to access the Data API. |
metric(metricName, props?) | Return the given named metric for this DBCluster. |
metric | This value is represented as a percentage. |
metric | The percentage of CPU utilization. |
metric | The number of database connections in use. |
metric | The average number of deadlocks in the database per second. |
metric | The amount of time that the instance has been running, in seconds. |
metric | The amount of local storage available, in bytes. |
metric | The amount of available random access memory, in bytes. |
metric | The amount of network throughput received from clients by each instance, in bytes per second. |
metric | The amount of network throughput both received from and transmitted to clients by each instance, in bytes per second. |
metric | The amount of network throughput sent to clients by each instance, in bytes per second. |
metric | As a cluster-level metric, it represents the average of the ServerlessDatabaseCapacity values of all the Aurora Serverless v2 DB instances in the cluster. |
metric | The total amount of backup storage in bytes consumed by all Aurora snapshots outside its backup retention window. |
metric | The total amount of backup storage in bytes for which you are billed. |
metric | The amount of storage used by your Aurora DB instance, in bytes. |
metric | The number of billed read I/O operations from a cluster volume, reported at 5-minute intervals. |
metric | The number of write disk I/O operations to the cluster volume, reported at 5-minute intervals. |
to | Returns a string representation of this construct. |
addProxy(id, options)
public addProxy(id: string, options: DatabaseProxyOptions): DatabaseProxy
Parameters
- id
string
- options
Database
Proxy Options
Returns
Add a new db proxy to this cluster.
addRotationMultiUser(id, options)
public addRotationMultiUser(id: string, options: RotationMultiUserOptions): SecretRotation
Parameters
- id
string
- options
Rotation
Multi User Options
Returns
Adds the multi user rotation to this cluster.
See Alternating users rotation strategy
addRotationSingleUser(options?)
public addRotationSingleUser(options?: RotationSingleUserOptions): SecretRotation
Parameters
- options
Rotation
Single User Options
Returns
Adds the single user rotation of the master password to this cluster.
See Single user rotation strategy
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
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
).
asSecretAttachmentTarget()
public asSecretAttachmentTarget(): SecretAttachmentTargetProps
Returns
Renders the secret attachment target specifications.
grantConnect(grantee, dbUser)
public grantConnect(grantee: IGrantable, dbUser: string): Grant
Parameters
- grantee
IGrantable
- dbUser
string
Returns
Grant the given identity connection access to the Cluster.
grantDataApiAccess(grantee)
public grantDataApiAccess(grantee: IGrantable): Grant
Parameters
- grantee
IGrantable
Returns
Grant the given identity to access the Data API.
metric(metricName, props?)
public metric(metricName: string, props?: MetricOptions): Metric
Parameters
- metricName
string
- props
Metric
Options
Returns
Return the given named metric for this DBCluster.
metricACUUtilization(props?)
public metricACUUtilization(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
This value is represented as a percentage.
It's calculated as the value of the ServerlessDatabaseCapacity metric divided by the maximum ACU value of the DB cluster.
If this metric approaches a value of 100.0, the DB instance has scaled up as high as it can. Consider increasing the maximum ACU setting for the cluster.
metricCPUUtilization(props?)
public metricCPUUtilization(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
The percentage of CPU utilization.
Average over 5 minutes
metricDatabaseConnections(props?)
public metricDatabaseConnections(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
The number of database connections in use.
Average over 5 minutes
metricDeadlocks(props?)
public metricDeadlocks(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
The average number of deadlocks in the database per second.
Average over 5 minutes
metricEngineUptime(props?)
public metricEngineUptime(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
The amount of time that the instance has been running, in seconds.
Average over 5 minutes
metricFreeLocalStorage(props?)
public metricFreeLocalStorage(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
The amount of local storage available, in bytes.
Average over 5 minutes
metricFreeableMemory(props?)
public metricFreeableMemory(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
The amount of available random access memory, in bytes.
Average over 5 minutes
metricNetworkReceiveThroughput(props?)
public metricNetworkReceiveThroughput(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
The amount of network throughput received from clients by each instance, in bytes per second.
Average over 5 minutes
metricNetworkThroughput(props?)
public metricNetworkThroughput(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
The amount of network throughput both received from and transmitted to clients by each instance, in bytes per second.
Average over 5 minutes
metricNetworkTransmitThroughput(props?)
public metricNetworkTransmitThroughput(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
The amount of network throughput sent to clients by each instance, in bytes per second.
Average over 5 minutes
metricServerlessDatabaseCapacity(props?)
public metricServerlessDatabaseCapacity(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
As a cluster-level metric, it represents the average of the ServerlessDatabaseCapacity values of all the Aurora Serverless v2 DB instances in the cluster.
metricSnapshotStorageUsed(props?)
public metricSnapshotStorageUsed(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
The total amount of backup storage in bytes consumed by all Aurora snapshots outside its backup retention window.
Average over 5 minutes
metricTotalBackupStorageBilled(props?)
public metricTotalBackupStorageBilled(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
The total amount of backup storage in bytes for which you are billed.
Average over 5 minutes
metricVolumeBytesUsed(props?)
public metricVolumeBytesUsed(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
The amount of storage used by your Aurora DB instance, in bytes.
Average over 5 minutes
metricVolumeReadIOPs(props?)
public metricVolumeReadIOPs(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
The number of billed read I/O operations from a cluster volume, reported at 5-minute intervals.
Average over 5 minutes
metricVolumeWriteIOPs(props?)
public metricVolumeWriteIOPs(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
The number of write disk I/O operations to the cluster volume, reported at 5-minute intervals.
Average over 5 minutes
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.