DatabaseInstanceReadReplicaProps
- class aws_cdk.aws_rds.DatabaseInstanceReadReplicaProps(*, vpc, auto_minor_version_upgrade=None, availability_zone=None, backup_retention=None, cloudwatch_logs_exports=None, cloudwatch_logs_retention=None, cloudwatch_logs_retention_role=None, copy_tags_to_snapshot=None, delete_automated_backups=None, deletion_protection=None, domain=None, domain_role=None, enable_performance_insights=None, iam_authentication=None, instance_identifier=None, iops=None, max_allocated_storage=None, monitoring_interval=None, monitoring_role=None, multi_az=None, option_group=None, parameter_group=None, performance_insight_encryption_key=None, performance_insight_retention=None, port=None, preferred_backup_window=None, preferred_maintenance_window=None, processor_features=None, publicly_accessible=None, removal_policy=None, s3_export_buckets=None, s3_export_role=None, s3_import_buckets=None, s3_import_role=None, security_groups=None, storage_type=None, subnet_group=None, vpc_placement=None, vpc_subnets=None, instance_type, source_database_instance, storage_encrypted=None, storage_encryption_key=None)
Bases:
DatabaseInstanceNewProps
Construction properties for a DatabaseInstanceReadReplica.
- Parameters:
vpc (
IVpc
) – The VPC network where the DB subnet group should be created.auto_minor_version_upgrade (
Optional
[bool
]) – Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window. Default: trueavailability_zone (
Optional
[str
]) – The name of the Availability Zone where the DB instance will be located. Default: - no preferencebackup_retention (
Optional
[Duration
]) – 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. Default: - Duration.days(1) for source instances, disabled for read replicascloudwatch_logs_exports (
Optional
[Sequence
[str
]]) – The list of log types that need to be enabled for exporting to CloudWatch Logs. Default: - no log exportscloudwatch_logs_retention (
Optional
[RetentionDays
]) – 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 toInfinity
. Default: - logs never expirecloudwatch_logs_retention_role (
Optional
[IRole
]) – The IAM role for the Lambda function associated with the custom resource that sets the retention policy. Default: - a new role is created.copy_tags_to_snapshot (
Optional
[bool
]) – Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default: truedelete_automated_backups (
Optional
[bool
]) – Indicates whether automated backups should be deleted or retained when you delete a DB instance. Default: falsedeletion_protection (
Optional
[bool
]) – Indicates whether the DB instance should have deletion protection enabled. Default: - true ifremovalPolicy
is RETAIN, false otherwisedomain (
Optional
[str
]) – The Active Directory directory ID to create the DB instance in. Default: - Do not join domaindomain_role (
Optional
[IRole
]) – The IAM role to be used when making API calls to the Directory Service. The role needs the AWS-managed policy AmazonRDSDirectoryServiceAccess or equivalent. Default: - The role will be created for you if {@link DatabaseInstanceNewProps#domain} is specifiedenable_performance_insights (
Optional
[bool
]) – Whether to enable Performance Insights for the DB instance. Default: - false, unlessperformanceInsightRentention
orperformanceInsightEncryptionKey
is set.iam_authentication (
Optional
[bool
]) – Whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. Default: falseinstance_identifier (
Optional
[str
]) – A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. Default: - a CloudFormation generated nameiops (
Union
[int
,float
,None
]) – The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. Default: - no provisioned iopsmax_allocated_storage (
Union
[int
,float
,None
]) – Upper limit to which RDS can scale the storage in GiB(Gibibyte). Default: - No autoscaling of RDS instancemonitoring_interval (
Optional
[Duration
]) – The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instance. Default: - no enhanced monitoringmonitoring_role (
Optional
[IRole
]) – Role that will be used to manage DB instance monitoring. Default: - A role is automatically created for youmulti_az (
Optional
[bool
]) – Specifies if the database instance is a multiple Availability Zone deployment. Default: falseoption_group (
Optional
[IOptionGroup
]) – The option group to associate with the instance. Default: - no option groupparameter_group (
Optional
[IParameterGroup
]) – The DB parameter group to associate with the instance. Default: - no parameter groupperformance_insight_encryption_key (
Optional
[IKey
]) – The AWS KMS key for encryption of Performance Insights data. Default: - default master keyperformance_insight_retention (
Optional
[PerformanceInsightRetention
]) – The amount of time, in days, to retain Performance Insights data. Default: 7port (
Union
[int
,float
,None
]) – The port for the instance. Default: - the default port for the chosen engine.preferred_backup_window (
Optional
[str
]) – The daily time range during which automated backups are performed. Constraints: - Must be in the formathh24:mi-hh24:mi
. - Must be in Universal Coordinated Time (UTC). - Must not conflict with the preferred maintenance window. - Must be at least 30 minutes. 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.BackupWindowpreferred_maintenance_window (
Optional
[str
]) – The weekly time range (in UTC) during which system maintenance can occur. Format:ddd:hh24:mi-ddd:hh24:mi
Constraint: Minimum 30-minute window 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.DBMaintenanceprocessor_features (
Union
[ProcessorFeatures
,Dict
[str
,Any
],None
]) – The number of CPU cores and the number of threads per core. 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_ConfigureProcessorpublicly_accessible (
Optional
[bool
]) – Indicates whether the DB instance is an internet-facing instance. Default: -true
ifvpcSubnets
issubnetType: SubnetType.PUBLIC
,false
otherwiseremoval_policy (
Optional
[RemovalPolicy
]) – The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update. Default: - RemovalPolicy.SNAPSHOT (remove the resource, but retain a snapshot of the data)s3_export_buckets (
Optional
[Sequence
[IBucket
]]) – S3 buckets that you want to load data into. This property must not be used ifs3ExportRole
is used. For Microsoft SQL Server: Default: - Nones3_export_role (
Optional
[IRole
]) – Role that will be associated with this DB instance to enable S3 export. This property must not be used ifs3ExportBuckets
is used. For Microsoft SQL Server: Default: - New role is created ifs3ExportBuckets
is set, no role is defined otherwises3_import_buckets (
Optional
[Sequence
[IBucket
]]) – 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 ifs3ImportRole
is used. For Microsoft SQL Server: Default: - Nones3_import_role (
Optional
[IRole
]) – 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 ifs3ImportBuckets
is used. For Microsoft SQL Server: Default: - New role is created ifs3ImportBuckets
is set, no role is defined otherwisesecurity_groups (
Optional
[Sequence
[ISecurityGroup
]]) – The security groups to assign to the DB instance. Default: - a new security group is createdstorage_type (
Optional
[StorageType
]) – The storage type. Storage types supported are gp2, io1, standard. Default: GP2subnet_group (
Optional
[ISubnetGroup
]) – Existing subnet group for the instance. Default: - a new subnet group will be created.vpc_placement (
Union
[SubnetSelection
,Dict
[str
,Any
],None
]) – (deprecated) The type of subnets to add to the created DB subnet group. Default: - private subnetsvpc_subnets (
Union
[SubnetSelection
,Dict
[str
,Any
],None
]) – The type of subnets to add to the created DB subnet group. Default: - private subnetsinstance_type (
InstanceType
) – The name of the compute and memory capacity classes.source_database_instance (
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.storage_encrypted (
Optional
[bool
]) – Indicates whether the DB instance is encrypted. Default: - true if storageEncryptionKey has been provided, false otherwisestorage_encryption_key (
Optional
[IKey
]) – The KMS key that’s used to encrypt the DB instance. Default: - default master key if storageEncrypted is true, no key otherwise
- ExampleMetadata:
infused
Example:
# vpc: ec2.Vpc # source_instance: rds.DatabaseInstance rds.DatabaseInstanceFromSnapshot(self, "Instance", snapshot_identifier="my-snapshot", engine=rds.DatabaseInstanceEngine.postgres(version=rds.PostgresEngineVersion.VER_12_3), # optional, defaults to m5.large instance_type=ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE2, ec2.InstanceSize.LARGE), vpc=vpc ) rds.DatabaseInstanceReadReplica(self, "ReadReplica", source_database_instance=source_instance, instance_type=ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE2, ec2.InstanceSize.LARGE), vpc=vpc )
Attributes
- auto_minor_version_upgrade
Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.
- Default:
true
- availability_zone
The name of the Availability Zone where the DB instance will be located.
- Default:
no preference
- backup_retention
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.
- Default:
Duration.days(1) for source instances, disabled for read replicas
- cloudwatch_logs_exports
The list of log types that need to be enabled for exporting to CloudWatch Logs.
- Default:
no log exports
- cloudwatch_logs_retention
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
.- Default:
logs never expire
- cloudwatch_logs_retention_role
The IAM role for the Lambda function associated with the custom resource that sets the retention policy.
- Default:
a new role is created.
- copy_tags_to_snapshot
Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance.
- Default:
true
- delete_automated_backups
Indicates whether automated backups should be deleted or retained when you delete a DB instance.
- Default:
false
- deletion_protection
Indicates whether the DB instance should have deletion protection enabled.
- Default:
true if
removalPolicy
is RETAIN, false otherwise
- domain
The Active Directory directory ID to create the DB instance in.
- Default:
Do not join domain
- domain_role
The IAM role to be used when making API calls to the Directory Service.
The role needs the AWS-managed policy AmazonRDSDirectoryServiceAccess or equivalent.
- Default:
The role will be created for you if {@link DatabaseInstanceNewProps#domain} is specified
- enable_performance_insights
Whether to enable Performance Insights for the DB instance.
- Default:
false, unless
performanceInsightRentention
orperformanceInsightEncryptionKey
is set.
- iam_authentication
Whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
- Default:
false
- instance_identifier
A name for the DB instance.
If you specify a name, AWS CloudFormation converts it to lowercase.
- Default:
a CloudFormation generated name
- instance_type
The name of the compute and memory capacity classes.
- iops
The number of I/O operations per second (IOPS) that the database provisions.
The value must be equal to or greater than 1000.
- Default:
no provisioned iops
- max_allocated_storage
Upper limit to which RDS can scale the storage in GiB(Gibibyte).
- Default:
No autoscaling of RDS instance
- See:
- monitoring_interval
The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instance.
- Default:
no enhanced monitoring
- monitoring_role
Role that will be used to manage DB instance monitoring.
- Default:
A role is automatically created for you
- multi_az
Specifies if the database instance is a multiple Availability Zone deployment.
- Default:
false
- option_group
The option group to associate with the instance.
- Default:
no option group
- parameter_group
The DB parameter group to associate with the instance.
- Default:
no parameter group
- performance_insight_encryption_key
The AWS KMS key for encryption of Performance Insights data.
- Default:
default master key
- performance_insight_retention
The amount of time, in days, to retain Performance Insights data.
- Default:
7
- port
The port for the instance.
- Default:
the default port for the chosen engine.
- preferred_backup_window
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.
- 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
- preferred_maintenance_window
The weekly time range (in UTC) during which system maintenance can occur.
Format:
ddd:hh24:mi-ddd:hh24:mi
Constraint: Minimum 30-minute window- 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
- processor_features
The number of CPU cores and the number of threads per core.
- Default:
the default number of CPU cores and threads per core for the
chosen instance class.
- publicly_accessible
Indicates whether the DB instance is an internet-facing instance.
- Default:
true
ifvpcSubnets
issubnetType: SubnetType.PUBLIC
,false
otherwise
- removal_policy
The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.
- Default:
RemovalPolicy.SNAPSHOT (remove the resource, but retain a snapshot of the data)
- s3_export_buckets
S3 buckets that you want to load data into.
This property must not be used if
s3ExportRole
is used.For Microsoft SQL Server:
- s3_export_role
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:
- Default:
New role is created if
s3ExportBuckets
is set, no role is defined otherwise
- See:
https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-s3-integration.html
- s3_import_buckets
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:
- s3_import_role
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:
- Default:
New role is created if
s3ImportBuckets
is set, no role is defined otherwise
- See:
https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL.Procedural.Importing.html
- security_groups
The security groups to assign to the DB instance.
- Default:
a new security group is created
- source_database_instance
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.
- storage_encrypted
Indicates whether the DB instance is encrypted.
- Default:
true if storageEncryptionKey has been provided, false otherwise
- storage_encryption_key
The KMS key that’s used to encrypt the DB instance.
- Default:
default master key if storageEncrypted is true, no key otherwise
- storage_type
The storage type.
Storage types supported are gp2, io1, standard.
- subnet_group
Existing subnet group for the instance.
- Default:
a new subnet group will be created.
- vpc
The VPC network where the DB subnet group should be created.
- vpc_placement
(deprecated) The type of subnets to add to the created DB subnet group.
- Default:
private subnets
- Deprecated:
use
vpcSubnets
- Stability:
deprecated
- vpc_subnets
The type of subnets to add to the created DB subnet group.
- Default:
private subnets