Package software.amazon.awscdk.services.rds

Enum InstanceUpdateBehaviour

java.lang.Object

java.lang.Enum<InstanceUpdateBehaviour>

software.amazon.awscdk.services.rds.InstanceUpdateBehaviour

All Implemented Interfaces:

Serializable, Comparable<InstanceUpdateBehaviour>, java.lang.constant.Constable

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-09-24T10:56:38.842Z")
@Stability(Stable)
public enum InstanceUpdateBehaviour
extends Enum<InstanceUpdateBehaviour>

The orchestration of updates of multiple instances.

Example:

 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();
 

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	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.

Method Summary

Modifier and Type	Method	Description
static InstanceUpdateBehaviour	valueOf(String name)	Returns the enum constant of this type with the specified name.
static InstanceUpdateBehaviour[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BULK

@Stability(Stable)
public static final InstanceUpdateBehaviour 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

@Stability(Stable)
public static final InstanceUpdateBehaviour 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.

Method Details

values

public static InstanceUpdateBehaviour[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static InstanceUpdateBehaviour valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null