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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.464Z")
 @Stability(value=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_12_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 and Description
static class	DatabaseInstanceReadReplicaProps.Builder A builder for DatabaseInstanceReadReplicaProps
static class	DatabaseInstanceReadReplicaProps.Jsii$Proxy An implementation for DatabaseInstanceReadReplicaProps

Method Summary

Modifier and Type	Method and Description
static DatabaseInstanceReadReplicaProps.Builder	builder()
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, getCloudwatchLogsExports, getCloudwatchLogsRetention, getCloudwatchLogsRetentionRole, getCopyTagsToSnapshot, getDeleteAutomatedBackups, getDeletionProtection, getDomain, getDomainRole, getEnablePerformanceInsights, getIamAuthentication, getInstanceIdentifier, getIops, getMaxAllocatedStorage, getMonitoringInterval, getMonitoringRole, getMultiAz, getOptionGroup, getParameterGroup, getPerformanceInsightEncryptionKey, getPerformanceInsightRetention, getPort, getPreferredBackupWindow, getPreferredMaintenanceWindow, getProcessorFeatures, getPubliclyAccessible, getRemovalPolicy, getS3ExportBuckets, getS3ExportRole, getS3ImportBuckets, getS3ImportRole, getSecurityGroups, getStorageType, getSubnetGroup, getVpc, getVpcSubnets

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getInstanceType

@Stability(value=Stable)
 @NotNull
InstanceType getInstanceType()

The name of the compute and memory capacity classes.

getSourceDatabaseInstance

@Stability(value=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.

getStorageEncrypted

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

Indicates whether the DB instance is encrypted.

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

getStorageEncryptionKey

@Stability(value=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(value=Stable)
static DatabaseInstanceReadReplicaProps.Builder builder()

Specified by:

builder in interface DatabaseInstanceNewProps

Returns:

a DatabaseInstanceReadReplicaProps.Builder of DatabaseInstanceReadReplicaProps