aws-cdk-lib.aws_rds.DatabaseInstanceReadReplicaProps

interface DatabaseInstanceReadReplicaProps

LanguageType name
.NETAmazon.CDK.AWS.RDS.DatabaseInstanceReadReplicaProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsrds#DatabaseInstanceReadReplicaProps
Javasoftware.amazon.awscdk.services.rds.DatabaseInstanceReadReplicaProps
Pythonaws_cdk.aws_rds.DatabaseInstanceReadReplicaProps
TypeScript (source)aws-cdk-lib » aws_rds » DatabaseInstanceReadReplicaProps

Construction properties for a DatabaseInstanceReadReplica.

Example

declare const vpc: ec2.Vpc;
new rds.DatabaseInstanceFromSnapshot(this, 'Instance', {
  snapshotIdentifier: 'my-snapshot',
  engine: rds.DatabaseInstanceEngine.postgres({ version: rds.PostgresEngineVersion.VER_15_2 }),
  // optional, defaults to m5.large
  instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE2, ec2.InstanceSize.LARGE),
  vpc,
});

declare const sourceInstance: rds.DatabaseInstance;
new rds.DatabaseInstanceReadReplica(this, 'ReadReplica', {
  sourceDatabaseInstance: sourceInstance,
  instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE2, ec2.InstanceSize.LARGE),
  vpc,
});

Properties

NameTypeDescription
instanceTypeInstanceTypeThe name of the compute and memory capacity classes.
sourceDatabaseInstanceIDatabaseInstanceThe source database instance.
vpcIVpcThe VPC network where the DB subnet group should be created.
autoMinorVersionUpgrade?booleanIndicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.
availabilityZone?stringThe name of the Availability Zone where the DB instance will be located.
backupRetention?DurationThe number of days during which automatic DB snapshots are retained.
cloudwatchLogsExports?string[]The list of log types that need to be enabled for exporting to CloudWatch Logs.
cloudwatchLogsRetention?RetentionDaysThe number of days log events are kept in CloudWatch Logs.
cloudwatchLogsRetentionRole?IRoleThe IAM role for the Lambda function associated with the custom resource that sets the retention policy.
copyTagsToSnapshot?booleanIndicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance.
deleteAutomatedBackups?booleanIndicates whether automated backups should be deleted or retained when you delete a DB instance.
deletionProtection?booleanIndicates whether the DB instance should have deletion protection enabled.
domain?stringThe Active Directory directory ID to create the DB instance in.
domainRole?IRoleThe IAM role to be used when making API calls to the Directory Service.
enablePerformanceInsights?booleanWhether to enable Performance Insights for the DB instance.
iamAuthentication?booleanWhether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
instanceIdentifier?stringA name for the DB instance.
iops?numberThe number of I/O operations per second (IOPS) that the database provisions.
maxAllocatedStorage?numberUpper limit to which RDS can scale the storage in GiB(Gibibyte).
monitoringInterval?DurationThe interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instance.
monitoringRole?IRoleRole that will be used to manage DB instance monitoring.
multiAz?booleanSpecifies if the database instance is a multiple Availability Zone deployment.
networkType?NetworkTypeThe network type of the DB instance.
optionGroup?IOptionGroupThe option group to associate with the instance.
parameterGroup?IParameterGroupThe DB parameter group to associate with the instance.
performanceInsightEncryptionKey?IKeyThe AWS KMS key for encryption of Performance Insights data.
performanceInsightRetention?PerformanceInsightRetentionThe amount of time, in days, to retain Performance Insights data.
port?numberThe port for the instance.
preferredBackupWindow?stringThe daily time range during which automated backups are performed.
preferredMaintenanceWindow?stringThe weekly time range (in UTC) during which system maintenance can occur.
processorFeatures?ProcessorFeaturesThe number of CPU cores and the number of threads per core.
publiclyAccessible?booleanIndicates whether the DB instance is an internet-facing instance.
removalPolicy?RemovalPolicyThe CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.
s3ExportBuckets?IBucket[]S3 buckets that you want to load data into.
s3ExportRole?IRoleRole that will be associated with this DB instance to enable S3 export.
s3ImportBuckets?IBucket[]S3 buckets that you want to load data from.
s3ImportRole?IRoleRole that will be associated with this DB instance to enable S3 import.
securityGroups?ISecurityGroup[]The security groups to assign to the DB instance.
storageEncrypted?booleanIndicates whether the DB instance is encrypted.
storageEncryptionKey?IKeyThe KMS key that's used to encrypt the DB instance.
storageThroughput?numberThe storage throughput, specified in mebibytes per second (MiBps).
storageType?StorageTypeThe storage type.
subnetGroup?ISubnetGroupExisting subnet group for the instance.
vpcSubnets?SubnetSelectionThe type of subnets to add to the created DB subnet group.

instanceType

Type: InstanceType

The name of the compute and memory capacity classes.


sourceDatabaseInstance

Type: IDatabaseInstance

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.


vpc

Type: IVpc

The VPC network where the DB subnet group should be created.


autoMinorVersionUpgrade?

Type: boolean (optional, default: true)

Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.


availabilityZone?

Type: string (optional, default: no preference)

The name of the Availability Zone where the DB instance will be located.


backupRetention?

Type: Duration (optional, default: Duration.days(1) for source instances, disabled for read replicas)

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

Set to zero to disable backups. When creating a read replica, you must enable automatic backups on the source database instance by setting the backup retention to a value other than zero.


cloudwatchLogsExports?

Type: string[] (optional, default: no log exports)

The list of log types that need to be enabled for exporting to CloudWatch Logs.


cloudwatchLogsRetention?

Type: RetentionDays (optional, default: logs never expire)

The number of days log events are kept in CloudWatch Logs.

When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to Infinity.


cloudwatchLogsRetentionRole?

Type: IRole (optional, default: a new role is created.)

The IAM role for the Lambda function associated with the custom resource that sets the retention policy.


copyTagsToSnapshot?

Type: boolean (optional, default: true)

Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance.


deleteAutomatedBackups?

Type: boolean (optional, default: false)

Indicates whether automated backups should be deleted or retained when you delete a DB instance.


deletionProtection?

Type: boolean (optional, default: true if removalPolicy is RETAIN, false otherwise)

Indicates whether the DB instance should have deletion protection enabled.


domain?

Type: string (optional, default: Do not join domain)

The Active Directory directory ID to create the DB instance in.


domainRole?

Type: IRole (optional, default: The role will be created for you if DatabaseInstanceNewProps#domain is specified)

The IAM role to be used when making API calls to the Directory Service.

The role needs the AWS-managed policy AmazonRDSDirectoryServiceAccess or equivalent.


enablePerformanceInsights?

Type: boolean (optional, default: false, unless performanceInsightRentention or performanceInsightEncryptionKey is set.)

Whether to enable Performance Insights for the DB instance.


iamAuthentication?

Type: boolean (optional, default: false)

Whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.


instanceIdentifier?

Type: string (optional, default: a CloudFormation generated name)

A name for the DB instance.

If you specify a name, AWS CloudFormation converts it to lowercase.


iops?

Type: number (optional, default: no provisioned iops if storage type is not specified. For GP3: 3,000 IOPS if allocated storage is less than 400 GiB for MariaDB, MySQL, and PostgreSQL, less than 200 GiB for Oracle and less than 20 GiB for SQL Server. 12,000 IOPS otherwise (except for SQL Server where the default is always 3,000 IOPS).)

The number of I/O operations per second (IOPS) that the database provisions.

The value must be equal to or greater than 1000.


maxAllocatedStorage?

Type: number (optional, default: No autoscaling of RDS instance)

Upper limit to which RDS can scale the storage in GiB(Gibibyte).

See also: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling


monitoringInterval?

Type: Duration (optional, default: no enhanced monitoring)

The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instance.


monitoringRole?

Type: IRole (optional, default: A role is automatically created for you)

Role that will be used to manage DB instance monitoring.


multiAz?

Type: boolean (optional, default: false)

Specifies if the database instance is a multiple Availability Zone deployment.


networkType?

Type: NetworkType (optional, default: IPV4)

The network type of the DB instance.


optionGroup?

Type: IOptionGroup (optional, default: no option group)

The option group to associate with the instance.


parameterGroup?

Type: IParameterGroup (optional, default: no parameter group)

The DB parameter group to associate with the instance.


performanceInsightEncryptionKey?

Type: IKey (optional, default: default master key)

The AWS KMS key for encryption of Performance Insights data.


performanceInsightRetention?

Type: PerformanceInsightRetention (optional, default: 7 this is the free tier)

The amount of time, in days, to retain Performance Insights data.


port?

Type: number (optional, default: the default port for the chosen engine.)

The port for the instance.


preferredBackupWindow?

Type: string (optional, default: a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow)

The daily time range during which automated backups are performed.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.
  • Must be in Universal Coordinated Time (UTC).
  • Must not conflict with the preferred maintenance window.
  • Must be at least 30 minutes.

preferredMaintenanceWindow?

Type: string (optional, default: a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance)

The weekly time range (in UTC) during which system maintenance can occur.

Format: ddd:hh24:mi-ddd:hh24:mi Constraint: Minimum 30-minute window


processorFeatures?

Type: ProcessorFeatures *(optional, default: the default number of CPU cores and threads per core for the chosen instance class.

See https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor)*

The number of CPU cores and the number of threads per core.


publiclyAccessible?

Type: boolean (optional, default: true if vpcSubnets is subnetType: SubnetType.PUBLIC, false otherwise)

Indicates whether the DB instance is an internet-facing instance.


removalPolicy?

Type: RemovalPolicy (optional, default: RemovalPolicy.SNAPSHOT (remove the resource, but retain a snapshot of the data))

The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.


s3ExportBuckets?

Type: IBucket[] (optional, default: None)

S3 buckets that you want to load data into.

This property must not be used if s3ExportRole is used.

For Microsoft SQL Server:

See also: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-s3-integration.html


s3ExportRole?

Type: IRole (optional, default: New role is created if s3ExportBuckets is set, no role is defined otherwise)

Role that will be associated with this DB instance to enable S3 export.

This property must not be used if s3ExportBuckets is used.

For Microsoft SQL Server:

See also: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-s3-integration.html


s3ImportBuckets?

Type: IBucket[] (optional, default: None)

S3 buckets that you want to load data from.

This feature is only supported by the Microsoft SQL Server, Oracle, and PostgreSQL engines.

This property must not be used if s3ImportRole is used.

For Microsoft SQL Server:

See also: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL.Procedural.Importing.html


s3ImportRole?

Type: IRole (optional, default: New role is created if s3ImportBuckets is set, no role is defined otherwise)

Role that will be associated with this DB instance to enable S3 import.

This feature is only supported by the Microsoft SQL Server, Oracle, and PostgreSQL engines.

This property must not be used if s3ImportBuckets is used.

For Microsoft SQL Server:

See also: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL.Procedural.Importing.html


securityGroups?

Type: ISecurityGroup[] (optional, default: a new security group is created)

The security groups to assign to the DB instance.


storageEncrypted?

Type: boolean (optional, default: true if storageEncryptionKey has been provided, false otherwise)

Indicates whether the DB instance is encrypted.


storageEncryptionKey?

Type: IKey (optional, default: default master key if storageEncrypted is true, no key otherwise)

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


storageThroughput?

Type: number (optional, default: 125 MiBps if allocated storage is less than 400 GiB for MariaDB, MySQL, and PostgreSQL, less than 200 GiB for Oracle and less than 20 GiB for SQL Server. 500 MiBps otherwise (except for SQL Server where the default is always 125 MiBps).)

The storage throughput, specified in mebibytes per second (MiBps).

Only applicable for GP3.

See also: https://docs.aws.amazon.com//AmazonRDS/latest/UserGuide/CHAP_Storage.html#gp3-storage


storageType?

Type: StorageType (optional, default: GP2)

The storage type.

Storage types supported are gp2, io1, standard.

See also: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#Concepts.Storage.GeneralSSD


subnetGroup?

Type: ISubnetGroup (optional, default: a new subnet group will be created.)

Existing subnet group for the instance.


vpcSubnets?

Type: SubnetSelection (optional, default: private subnets)

The type of subnets to add to the created DB subnet group.