Interface IServerlessClusterFromSnapshotProps

Properties for ServerlessClusterFromSnapshot.

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IServerlessClusterFromSnapshotProps

Syntax (vb)

Public Interface IServerlessClusterFromSnapshotProps

Remarks

ExampleMetadata: infused

Examples

Vpc vpc;

            new ServerlessClusterFromSnapshot(this, "Cluster", new ServerlessClusterFromSnapshotProps {
                Engine = DatabaseClusterEngine.AURORA_MYSQL,
                Vpc = vpc,
                SnapshotIdentifier = "mySnapshot"
            });

Synopsis

Properties

BackupRetention	The number of days during which automatic DB snapshots are retained.
ClusterIdentifier	An optional identifier for the cluster.
CopyTagsToSnapshot	Whether to copy tags to the snapshot when a snapshot is created.
Credentials	Master user credentials.
DefaultDatabaseName	Name of a database which is automatically created inside the cluster.
DeletionProtection	Indicates whether the DB cluster should have deletion protection enabled.
EnableDataApi	Whether to enable the Data API.
Engine	What kind of database to start.
ParameterGroup	Additional parameters to pass to the database engine.
RemovalPolicy	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.
SecurityGroups	Security group.
SnapshotIdentifier	The identifier for the DB instance snapshot or DB cluster snapshot to restore from.
SubnetGroup	Existing subnet group for the cluster.
Vpc	The VPC that this Aurora Serverless v1 Cluster has been created in.
VpcSubnets	Where to place the instances within the VPC.

Properties

BackupRetention

The number of days during which automatic DB snapshots are retained.

Duration? BackupRetention { get; }

Property Value

Duration

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.

string? ClusterIdentifier { get; }

Property Value

string

Remarks

Default: - A name is automatically generated.

CopyTagsToSnapshot

Whether to copy tags to the snapshot when a snapshot is created.

bool? CopyTagsToSnapshot { get; }

Property Value

bool?

Remarks

Default: - true

Credentials

Master user credentials.

SnapshotCredentials? Credentials { get; }

Property Value

SnapshotCredentials

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.

string? DefaultDatabaseName { get; }

Property Value

string

Remarks

Default: - Database is not created in cluster.

DeletionProtection

Indicates whether the DB cluster should have deletion protection enabled.

bool? DeletionProtection { get; }

Property Value

bool?

Remarks

Default: - true if removalPolicy is RETAIN, false otherwise

EnableDataApi

Whether to enable the Data API.

bool? EnableDataApi { get; }

Property Value

bool?

Remarks

Default: false

See: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html

Engine

What kind of database to start.

IClusterEngine Engine { get; }

Property Value

IClusterEngine

Remarks

ExampleMetadata: infused

ParameterGroup

Additional parameters to pass to the database engine.

IParameterGroup? ParameterGroup { get; }

Property Value

IParameterGroup

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.

RemovalPolicy? RemovalPolicy { get; }

Property Value

RemovalPolicy?

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.

IServerlessScalingOptions? Scaling { get; }

Property Value

IServerlessScalingOptions

Remarks

Default: - Serverless cluster is automatically paused after 5 minutes of being idle. minimum capacity: 2 ACU maximum capacity: 16 ACU

SecurityGroups

Security group.

ISecurityGroup[]? SecurityGroups { get; }

Property Value

ISecurityGroup[]

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.

string SnapshotIdentifier { get; }

Property Value

string

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.

ISubnetGroup? SubnetGroup { get; }

Property Value

ISubnetGroup

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.

IVpc? Vpc { get; }

Property Value

IVpc

Remarks

Default: - the default VPC in the account and region will be used

VpcSubnets

Where to place the instances within the VPC.

ISubnetSelection? VpcSubnets { get; }

Property Value

ISubnetSelection

Remarks

If provided, the vpc property must also be specified.

Default: - the VPC default strategy if not specified.