Class DatabaseClusterFromSnapshot
A database cluster restored from a snapshot.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class DatabaseClusterFromSnapshot : DatabaseClusterBase, IDatabaseCluster, IResource, IConnectable, ISecretAttachmentTarget
Syntax (vb)
Public Class DatabaseClusterFromSnapshot
Inherits DatabaseClusterBase
Implements IDatabaseCluster, IResource, IConnectable, ISecretAttachmentTarget
Remarks
Resource: AWS::RDS::DBCluster
ExampleMetadata: infused
Examples
Vpc vpc;
new DatabaseClusterFromSnapshot(this, "Database", new DatabaseClusterFromSnapshotProps {
Engine = DatabaseClusterEngine.Aurora(new AuroraClusterEngineProps { Version = AuroraEngineVersion.VER_1_22_2 }),
Writer = ClusterInstance.Provisioned("writer"),
Vpc = vpc,
SnapshotIdentifier = "mySnapshot"
});
Synopsis
Constructors
DatabaseClusterFromSnapshot(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
DatabaseClusterFromSnapshot(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
DatabaseClusterFromSnapshot(Construct, String, IDatabaseClusterFromSnapshotProps) |
Properties
CloudwatchLogGroups | The log group is created when |
ClusterEndpoint | The endpoint to use for read/write operations. |
ClusterIdentifier | Identifier of the cluster. |
ClusterReadEndpoint | Endpoint to use for load-balanced read-only operations. |
ClusterResourceIdentifier | The immutable identifier for the cluster; for example: cluster-ABCD1234EFGH5678IJKL90MNOP. |
Connections | Access to the network connections. |
EnableDataApi | |
Engine | The engine for this Cluster. |
HasServerlessInstance | |
InstanceEndpoints | Endpoints which address each individual replica. |
InstanceIdentifiers | Identifiers of the replicas. |
MultiUserRotationApplication | Application for multi user rotation to this cluster. |
NewCfnProps | |
PerformanceInsightEncryptionKey | The AWS KMS key for encryption of Performance Insights data. |
PerformanceInsightRetention | The amount of time, in days, to retain Performance Insights data. |
PerformanceInsightsEnabled | Whether Performance Insights is enabled at cluster level. |
Secret | The secret attached to this cluster. |
SecurityGroups | |
ServerlessV2MaxCapacity | |
ServerlessV2MinCapacity | |
SingleUserRotationApplication | Application for single user rotation of the master password to this cluster. |
SubnetGroup | |
Vpc | The VPC network to place the cluster in. |
VpcSubnets | The cluster's subnets. |
Methods
AddRotationMultiUser(String, IRotationMultiUserOptions) | Adds the multi user rotation to this cluster. |
AddRotationSingleUser(IRotationSingleUserOptions) | Adds the single user rotation of the master password to this cluster. |
MetricACUUtilization(IMetricOptions) | This value is represented as a percentage. |
MetricServerlessDatabaseCapacity(IMetricOptions) | As a cluster-level metric, it represents the average of the ServerlessDatabaseCapacity values of all the Aurora Serverless v2 DB instances in the cluster. |
Constructors
DatabaseClusterFromSnapshot(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected DatabaseClusterFromSnapshot(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
DatabaseClusterFromSnapshot(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected DatabaseClusterFromSnapshot(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
DatabaseClusterFromSnapshot(Construct, String, IDatabaseClusterFromSnapshotProps)
public DatabaseClusterFromSnapshot(Construct scope, string id, IDatabaseClusterFromSnapshotProps props)
Parameters
- scope Constructs.Construct
- id System.String
- props IDatabaseClusterFromSnapshotProps
Properties
CloudwatchLogGroups
The log group is created when cloudwatchLogsExports
is set.
public virtual IDictionary<string, ILogGroup> CloudwatchLogGroups { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, ILogGroup>
Remarks
Each export value will create a separate log group.
ClusterEndpoint
The endpoint to use for read/write operations.
public override Endpoint ClusterEndpoint { get; }
Property Value
Overrides
ClusterIdentifier
Identifier of the cluster.
public override string ClusterIdentifier { get; }
Property Value
System.String
Overrides
ClusterReadEndpoint
Endpoint to use for load-balanced read-only operations.
public override Endpoint ClusterReadEndpoint { get; }
Property Value
Overrides
ClusterResourceIdentifier
The immutable identifier for the cluster; for example: cluster-ABCD1234EFGH5678IJKL90MNOP.
public override string ClusterResourceIdentifier { get; }
Property Value
System.String
Overrides
Remarks
This AWS Region-unique identifier is used in things like IAM authentication policies.
Connections
Access to the network connections.
public override Connections_ Connections { get; }
Property Value
Overrides
EnableDataApi
protected override Nullable<bool> EnableDataApi { get; set; }
Property Value
System.Nullable<System.Boolean>
Overrides
Engine
The engine for this Cluster.
public override IClusterEngine Engine { get; }
Property Value
Overrides
Remarks
Never undefined.
HasServerlessInstance
protected virtual Nullable<bool> HasServerlessInstance { get; set; }
Property Value
System.Nullable<System.Boolean>
InstanceEndpoints
Endpoints which address each individual replica.
public override Endpoint[] InstanceEndpoints { get; }
Property Value
Endpoint[]
Overrides
InstanceIdentifiers
Identifiers of the replicas.
public override string[] InstanceIdentifiers { get; }
Property Value
System.String[]
Overrides
MultiUserRotationApplication
Application for multi user rotation to this cluster.
public virtual SecretRotationApplication MultiUserRotationApplication { get; }
Property Value
NewCfnProps
PerformanceInsightEncryptionKey
The AWS KMS key for encryption of Performance Insights data.
public virtual IKey PerformanceInsightEncryptionKey { get; }
Property Value
PerformanceInsightRetention
The amount of time, in days, to retain Performance Insights data.
public virtual Nullable<PerformanceInsightRetention> PerformanceInsightRetention { get; }
Property Value
System.Nullable<PerformanceInsightRetention>
PerformanceInsightsEnabled
Whether Performance Insights is enabled at cluster level.
public virtual bool PerformanceInsightsEnabled { get; }
Property Value
System.Boolean
Secret
The secret attached to this cluster.
public override ISecret Secret { get; }
Property Value
Overrides
SecurityGroups
ServerlessV2MaxCapacity
protected virtual double ServerlessV2MaxCapacity { get; }
Property Value
System.Double
ServerlessV2MinCapacity
protected virtual double ServerlessV2MinCapacity { get; }
Property Value
System.Double
SingleUserRotationApplication
Application for single user rotation of the master password to this cluster.
public virtual SecretRotationApplication SingleUserRotationApplication { get; }
Property Value
SubnetGroup
Vpc
VpcSubnets
The cluster's subnets.
public virtual ISubnetSelection VpcSubnets { get; }
Property Value
Methods
AddRotationMultiUser(String, IRotationMultiUserOptions)
Adds the multi user rotation to this cluster.
public virtual SecretRotation AddRotationMultiUser(string id, IRotationMultiUserOptions options)
Parameters
- id System.String
- options IRotationMultiUserOptions
Returns
Remarks
AddRotationSingleUser(IRotationSingleUserOptions)
Adds the single user rotation of the master password to this cluster.
public virtual SecretRotation AddRotationSingleUser(IRotationSingleUserOptions options = null)
Parameters
- options IRotationSingleUserOptions
Returns
Remarks
MetricACUUtilization(IMetricOptions)
This value is represented as a percentage.
public virtual Metric MetricACUUtilization(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
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.
MetricServerlessDatabaseCapacity(IMetricOptions)
As a cluster-level metric, it represents the average of the ServerlessDatabaseCapacity values of all the Aurora Serverless v2 DB instances in the cluster.
public virtual Metric MetricServerlessDatabaseCapacity(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns