Package software.amazon.awscdk.services.rds

Interface ServerlessClusterFromSnapshotProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ServerlessClusterFromSnapshotProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:49.264Z") @Stability(Stable) public interface ServerlessClusterFromSnapshotProps extends software.amazon.jsii.JsiiSerializable
Properties for ServerlessClusterFromSnapshot.

Example: 

 Vpc vpc;
 ServerlessClusterFromSnapshot.Builder.create(this, "Cluster")
         .engine(DatabaseClusterEngine.AURORA_MYSQL)
         .vpc(vpc)
         .snapshotIdentifier("mySnapshot")
         .build();

  • Method Details

    • getEngine

      @Stability(Stable) @NotNull IClusterEngine getEngine()
      What kind of database to start.

    • getSnapshotIdentifier

      @Stability(Stable) @NotNull String getSnapshotIdentifier()
      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.

    • getBackupRetention

      @Stability(Stable) @Nullable default Duration getBackupRetention()
      The number of days during which automatic DB snapshots are retained.

      Automatic backup retention cannot be disabled on serverless clusters. Must be a value from 1 day to 35 days.

      Default: Duration.days(1)

    • getClusterIdentifier

      @Stability(Stable) @Nullable default String getClusterIdentifier()
      An optional identifier for the cluster.

      Default: - A name is automatically generated.

    • getCredentials

      @Stability(Stable) @Nullable default SnapshotCredentials getCredentials()
      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.

      Default: - The existing username and password from the snapshot will be used.

    • getDefaultDatabaseName

      @Stability(Stable) @Nullable default String getDefaultDatabaseName()
      Name of a database which is automatically created inside the cluster.

      Default: - Database is not created in cluster.

    • getDeletionProtection

      @Stability(Stable) @Nullable default Boolean getDeletionProtection()
      Indicates whether the DB cluster should have deletion protection enabled.

      Default: - true if removalPolicy is RETAIN, false otherwise

    • getEnableDataApi

      @Stability(Stable) @Nullable default Boolean getEnableDataApi()
      Whether to enable the Data API.

      Default: false

      See Also:

    • getParameterGroup

      @Stability(Stable) @Nullable default IParameterGroup getParameterGroup()
      Additional parameters to pass to the database engine.

      Default: - no parameter group.

    • getRemovalPolicy

      @Stability(Stable) @Nullable default RemovalPolicy getRemovalPolicy()
      The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update.

      Default: - RemovalPolicy.SNAPSHOT (remove the cluster and instances, but retain a snapshot of the data)

    • getScaling

      @Stability(Stable) @Nullable default ServerlessScalingOptions getScaling()
      Scaling configuration of an Aurora Serverless database cluster.

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

    • getSecurityGroups

      @Stability(Stable) @Nullable default List<ISecurityGroup> getSecurityGroups()
      Security group.

      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.

    • getSubnetGroup

      @Stability(Stable) @Nullable default ISubnetGroup getSubnetGroup()
      Existing subnet group for the cluster.

      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

    • getVpc

      @Stability(Stable) @Nullable default IVpc getVpc()
      The VPC that this Aurora Serverless cluster has been created in.

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

    • getVpcSubnets

      @Stability(Stable) @Nullable default SubnetSelection getVpcSubnets()
      Where to place the instances within the VPC.

      If provided, the vpc property must also be specified.

      Default: - the VPC default strategy if not specified.

    • builder

      @Stability(Stable) static ServerlessClusterFromSnapshotProps.Builder builder()
      Returns:
      a ServerlessClusterFromSnapshotProps.Builder of ServerlessClusterFromSnapshotProps