# InstanceUpdateBehaviour

The orchestration of updates of multiple instances.

- Source: [`aws-rds/lib/cluster.ts`](https://github.com/aws/aws-cdk/blob/v2.277.0/packages/aws-cdk-lib/aws-rds/lib/cluster.ts#L541)
- Type last changed: v2.32.0 · 14 Jul 2022

## Example

TypeScript:

```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,
});
```

Python:

```python
# vpc: ec2.Vpc

cluster = rds.DatabaseCluster(self, "Database",
    engine=rds.DatabaseClusterEngine.aurora_mysql(version=rds.AuroraMysqlEngineVersion.VER_3_01_0),
    writer=rds.ClusterInstance.provisioned("Instance",
        instance_type=ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE3, ec2.InstanceSize.SMALL)
    ),
    readers=[rds.ClusterInstance.provisioned("reader")],
    instance_update_behaviour=rds.InstanceUpdateBehaviour.ROLLING,  # Optional - defaults to rds.InstanceUpdateBehaviour.BULK
    vpc=vpc
)
```

Java:

```java
Vpc vpc;

DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "Database")
        .engine(DatabaseClusterEngine.auroraMysql(AuroraMysqlClusterEngineProps.builder().version(AuroraMysqlEngineVersion.VER_3_01_0).build()))
        .writer(ClusterInstance.provisioned("Instance", ProvisionedClusterInstanceProps.builder()
                .instanceType(InstanceType.of(InstanceClass.BURSTABLE3, InstanceSize.SMALL))
                .build()))
        .readers(List.of(ClusterInstance.provisioned("reader")))
        .instanceUpdateBehaviour(InstanceUpdateBehaviour.ROLLING) // Optional - defaults to rds.InstanceUpdateBehaviour.BULK
        .vpc(vpc)
        .build();
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.Lib
Vpc vpc;

var cluster = new DatabaseCluster(this, "Database", new DatabaseClusterProps {
    Engine = DatabaseClusterEngine.AuroraMysql(new AuroraMysqlClusterEngineProps { Version = AuroraMysqlEngineVersion.VER_3_01_0 }),
    Writer = ClusterInstance.Provisioned("Instance", new ProvisionedClusterInstanceProps {
        InstanceType = InstanceType.Of(InstanceClass.BURSTABLE3, InstanceSize.SMALL)
    }),
    Readers = new [] { ClusterInstance.Provisioned("reader") },
    InstanceUpdateBehaviour = InstanceUpdateBehaviour.ROLLING,  // Optional - defaults to rds.InstanceUpdateBehaviour.BULK
    Vpc = vpc
});
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var vpc Vpc

cluster := rds.NewDatabaseCluster(this, jsii.String("Database"), &DatabaseClusterProps{
	Engine: rds.DatabaseClusterEngine_AuroraMysql(&AuroraMysqlClusterEngineProps{
		Version: rds.AuroraMysqlEngineVersion_VER_3_01_0(),
	}),
	Writer: rds.ClusterInstance_Provisioned(jsii.String("Instance"), &ProvisionedClusterInstanceProps{
		InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_BURSTABLE3, ec2.InstanceSize_SMALL),
	}),
	Readers: []IClusterInstance{
		rds.ClusterInstance_*Provisioned(jsii.String("reader")),
	},
	InstanceUpdateBehaviour: rds.InstanceUpdateBehaviour_ROLLING,
	 // Optional - defaults to rds.InstanceUpdateBehaviour.BULK
	Vpc: Vpc,
})
```

## Members

| Member | Description |
| --- | --- |
| `BULK` | In a bulk update, all instances of the cluster are updated at the same time. |
| `ROLLING` | In a rolling update, one instance after another is updated. |

## Referenced by

- [`DatabaseClusterFromSnapshotProps`](/v2/docs/aws-cdk-lib.aws_rds.DatabaseClusterFromSnapshotProps).instanceUpdateBehaviour
- [`DatabaseClusterProps`](/v2/docs/aws-cdk-lib.aws_rds.DatabaseClusterProps).instanceUpdateBehaviour
