Class ServerlessClusterFromSnapshotProps
Properties for ServerlessClusterFromSnapshot.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ServerlessClusterFromSnapshotProps : Object, IServerlessClusterFromSnapshotPropsSyntax (vb)
Public Class ServerlessClusterFromSnapshotProps
Inherits Object
Implements IServerlessClusterFromSnapshotPropsRemarks
ExampleMetadata: infused
Examples
Vpc vpc;
new ServerlessClusterFromSnapshot(this, "Cluster", new ServerlessClusterFromSnapshotProps {
Engine = DatabaseClusterEngine.AURORA_MYSQL,
Vpc = vpc,
SnapshotIdentifier = "mySnapshot"
});Synopsis
Constructors
| Serverless |
Properties
| Backup |
The number of days during which automatic DB snapshots are retained. |
| Cluster |
An optional identifier for the cluster. |
| Copy |
Whether to copy tags to the snapshot when a snapshot is created. |
| Credentials | Master user credentials. |
| Default |
Name of a database which is automatically created inside the cluster. |
| Deletion |
Indicates whether the DB cluster should have deletion protection enabled. |
| Enable |
Whether to enable the Data API. |
| Engine | What kind of database to start. |
| Parameter |
Additional parameters to pass to the database engine. |
| Removal |
The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update. |
| Scaling | Scaling configuration of an Aurora Serverless database cluster. |
| Security |
Security group. |
| Snapshot |
The identifier for the DB instance snapshot or DB cluster snapshot to restore from. |
| Subnet |
Existing subnet group for the cluster. |
| Vpc | The VPC that this Aurora Serverless v1 Cluster has been created in. |
| Vpc |
Where to place the instances within the VPC. |
Constructors
ServerlessClusterFromSnapshotProps()
public ServerlessClusterFromSnapshotProps()Properties
BackupRetention
The number of days during which automatic DB snapshots are retained.
public Duration BackupRetention { get; set; }Property Value
Remarks
Automatic backup retention cannot be disabled on serverless clusters. Must be a value from 1 day to 35 days.
Default: Duration.days(1)
ClusterIdentifier
An optional identifier for the cluster.
public string ClusterIdentifier { get; set; }Property Value
System.
Remarks
Default: - A name is automatically generated.
CopyTagsToSnapshot
Whether to copy tags to the snapshot when a snapshot is created.
public Nullable<bool> CopyTagsToSnapshot { get; set; }Property Value
System.
Remarks
Default: - true
Credentials
Master user credentials.
public SnapshotCredentials Credentials { get; set; }Property Value
Remarks
Note - It is not possible to change the master username for a snapshot; however, it is possible to provide (or generate) a new password.
Default: - The existing username and password from the snapshot will be used.
DefaultDatabaseName
Name of a database which is automatically created inside the cluster.
public string DefaultDatabaseName { get; set; }Property Value
System.
Remarks
Default: - Database is not created in cluster.
DeletionProtection
Indicates whether the DB cluster should have deletion protection enabled.
public Nullable<bool> DeletionProtection { get; set; }Property Value
System.
Remarks
Default: - true if removalPolicy is RETAIN, false otherwise
EnableDataApi
Whether to enable the Data API.
public Nullable<bool> EnableDataApi { get; set; }Property Value
System.
Remarks
Default: false
See: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
Engine
What kind of database to start.
public IClusterEngine Engine { get; set; }Property Value
ParameterGroup
Additional parameters to pass to the database engine.
public IParameterGroup ParameterGroup { get; set; }Property Value
Remarks
Default: - no parameter group.
RemovalPolicy
The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update.
public Nullable<RemovalPolicy> RemovalPolicy { get; set; }Property Value
System.
Remarks
Default: - RemovalPolicy.SNAPSHOT (remove the cluster and instances, but retain a snapshot of the data)
Scaling
Scaling configuration of an Aurora Serverless database cluster.
public IServerlessScalingOptions Scaling { get; set; }Property Value
Remarks
Default: - Serverless cluster is automatically paused after 5 minutes of being idle. minimum capacity: 2 ACU maximum capacity: 16 ACU
SecurityGroups
Security group.
public ISecurityGroup[] SecurityGroups { get; set; }Property Value
Remarks
Default: - a new security group is created if vpc was provided.
If the vpc property was not provided, no VPC security groups will be associated with the DB cluster.
SnapshotIdentifier
The identifier for the DB instance snapshot or DB cluster snapshot to restore from.
public string SnapshotIdentifier { get; set; }Property Value
System.
Remarks
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.
SubnetGroup
Existing subnet group for the cluster.
public ISubnetGroup SubnetGroup { get; set; }Property Value
Remarks
Default: - a new subnet group is created if vpc was provided.
If the vpc property was not provided, no subnet group will be associated with the DB cluster
Vpc
The VPC that this Aurora Serverless v1 Cluster has been created in.
public IVpc Vpc { get; set; }Property Value
Remarks
Default: - the default VPC in the account and region will be used
VpcSubnets
Where to place the instances within the VPC.
public ISubnetSelection VpcSubnets { get; set; }Property Value
Remarks
If provided, the vpc property must also be specified.
Default: - the VPC default strategy if not specified.