Package software.amazon.awscdk.services.rds

Interface DatabaseInstanceFromSnapshotProps

All Superinterfaces:

DatabaseInstanceNewProps, DatabaseInstanceSourceProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DatabaseInstanceFromSnapshotProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:08.306Z")
@Stability(Stable)
public interface DatabaseInstanceFromSnapshotProps
extends software.amazon.jsii.JsiiSerializable, DatabaseInstanceSourceProps

Construction properties for a DatabaseInstanceFromSnapshot.

Example:

 Vpc vpc;
 DatabaseInstance sourceInstance;
 DatabaseInstanceFromSnapshot.Builder.create(this, "Instance")
         .snapshotIdentifier("my-snapshot")
         .engine(DatabaseInstanceEngine.postgres(PostgresInstanceEngineProps.builder().version(PostgresEngineVersion.VER_16_3).build()))
         // optional, defaults to m5.large
         .instanceType(InstanceType.of(InstanceClass.BURSTABLE2, InstanceSize.LARGE))
         .vpc(vpc)
         .build();
 DatabaseInstanceReadReplica.Builder.create(this, "ReadReplica")
         .sourceDatabaseInstance(sourceInstance)
         .instanceType(InstanceType.of(InstanceClass.BURSTABLE2, InstanceSize.LARGE))
         .vpc(vpc)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	DatabaseInstanceFromSnapshotProps.Builder	A builder for DatabaseInstanceFromSnapshotProps
static final class	DatabaseInstanceFromSnapshotProps.Jsii$Proxy	An implementation for DatabaseInstanceFromSnapshotProps

Method Summary

Modifier and Type	Method	Description
static DatabaseInstanceFromSnapshotProps.Builder	builder()
default SnapshotCredentials	getCredentials()	Master user credentials.
String	getSnapshotIdentifier()	The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance.

Methods inherited from interface software.amazon.awscdk.services.rds.DatabaseInstanceNewProps

getAutoMinorVersionUpgrade, getAvailabilityZone, getBackupRetention, getCaCertificate, getCloudwatchLogsExports, getCloudwatchLogsRetention, getCloudwatchLogsRetentionRole, getCopyTagsToSnapshot, getDeleteAutomatedBackups, getDeletionProtection, getDomain, getDomainRole, getEnablePerformanceInsights, getIamAuthentication, getInstanceIdentifier, getIops, getMaxAllocatedStorage, getMonitoringInterval, getMonitoringRole, getMultiAz, getNetworkType, getOptionGroup, getParameterGroup, getPerformanceInsightEncryptionKey, getPerformanceInsightRetention, getPort, getPreferredBackupWindow, getPreferredMaintenanceWindow, getProcessorFeatures, getPubliclyAccessible, getRemovalPolicy, getS3ExportBuckets, getS3ExportRole, getS3ImportBuckets, getS3ImportRole, getSecurityGroups, getStorageThroughput, getStorageType, getSubnetGroup, getVpc, getVpcSubnets

Methods inherited from interface software.amazon.awscdk.services.rds.DatabaseInstanceSourceProps

getAllocatedStorage, getAllowMajorVersionUpgrade, getDatabaseName, getEngine, getInstanceType, getLicenseModel, getParameters, getTimezone

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSnapshotIdentifier

@Stability(Stable)
@NotNull
String getSnapshotIdentifier()

The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance.

If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot.

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.

builder

@Stability(Stable)
static DatabaseInstanceFromSnapshotProps.Builder builder()

Returns:

a DatabaseInstanceFromSnapshotProps.Builder of DatabaseInstanceFromSnapshotProps