Package software.amazon.awscdk.services.rds

Interface DatabaseInstanceReadReplicaProps

All Superinterfaces:

DatabaseInstanceNewProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DatabaseInstanceReadReplicaProps.Jsii$Proxy

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

Construction properties for a DatabaseInstanceReadReplica.

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	DatabaseInstanceReadReplicaProps.Builder	A builder for DatabaseInstanceReadReplicaProps
static final class	DatabaseInstanceReadReplicaProps.Jsii$Proxy	An implementation for DatabaseInstanceReadReplicaProps

Method Summary

Modifier and Type	Method	Description
static DatabaseInstanceReadReplicaProps.Builder	builder()
default Number	getAllocatedStorage()	The allocated storage size, specified in gibibytes (GiB).
InstanceType	getInstanceType()	The name of the compute and memory capacity classes.
IDatabaseInstance	getSourceDatabaseInstance()	The source database instance.
default Boolean	getStorageEncrypted()	Indicates whether the DB instance is encrypted.
default IKey	getStorageEncryptionKey()	The KMS key that's used to encrypt 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.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInstanceType

@Stability(Stable)
@NotNull
InstanceType getInstanceType()

The name of the compute and memory capacity classes.

getSourceDatabaseInstance

@Stability(Stable)
@NotNull
IDatabaseInstance getSourceDatabaseInstance()

The source database instance.

Each DB instance can have a limited number of read replicas. For more information, see https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html.

getAllocatedStorage

@Stability(Stable)
@Nullable
default Number getAllocatedStorage()

The allocated storage size, specified in gibibytes (GiB).

Default: - The replica will inherit the allocated storage of the source database instance

getStorageEncrypted

@Stability(Stable)
@Nullable
default Boolean getStorageEncrypted()

Indicates whether the DB instance is encrypted.

Default: - true if storageEncryptionKey has been provided, false otherwise

getStorageEncryptionKey

@Stability(Stable)
@Nullable
default IKey getStorageEncryptionKey()

The KMS key that's used to encrypt the DB instance.

Default: - default master key if storageEncrypted is true, no key otherwise

builder

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

Returns:

a DatabaseInstanceReadReplicaProps.Builder of DatabaseInstanceReadReplicaProps