aws-cdk-lib.aws_rds.InstanceUpdateBehaviour

enum InstanceUpdateBehaviour

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

The orchestration of updates of multiple instances.

Example

declare const vpc: ec2.Vpc;
const cluster = new rds.DatabaseCluster(this, 'Database', {
  engine: rds.DatabaseClusterEngine.auroraMysql({ version: rds.AuroraMysqlEngineVersion.VER_3_01_0 }),
  writer: rds.ClusterInstance.provisioned({
    instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE3, ec2.InstanceSize.SMALL),
  }),
  readers [rds.ClusterInstance.provisioned('reader')],
  instanceUpdateBehaviour: rds.InstanceUpdateBehaviour.ROLLING, // Optional - defaults to rds.InstanceUpdateBehaviour.BULK
  vpc,
});

Members

NameDescription
BULKIn a bulk update, all instances of the cluster are updated at the same time.
ROLLINGIn a rolling update, one instance after another is updated.

BULK

In a bulk update, all instances of the cluster are updated at the same time.

This results in a faster update procedure. During the update, however, all instances might be unavailable at the same time and thus a downtime might occur.


ROLLING

In a rolling update, one instance after another is updated.

This results in at most one instance being unavailable during the update. If your cluster consists of more than 1 instance, the downtime periods are limited to the time a primary switch needs.