AWS CDK Reference

Appearance

v2.274.0

InstanceUpdateBehaviour Enum ​

The orchestration of updates of multiple instances.

Source
aws-rds/lib/cluster.ts
Type last changed
v2.32.0 · 14 Jul 2022

Example ​

ts
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('Instance', {
    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 ​

MemberDescription
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.

Referenced by ​

  • DatabaseClusterFromSnapshotProps.instanceUpdateBehaviourinstance_update_behaviourinstanceUpdateBehaviourInstanceUpdateBehaviourInstanceUpdateBehaviour
  • DatabaseClusterProps.instanceUpdateBehaviourinstance_update_behaviourinstanceUpdateBehaviourInstanceUpdateBehaviourInstanceUpdateBehaviour