Package software.amazon.awscdk.services.rds

Class DatabaseClusterEngine

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.rds.DatabaseClusterEngine

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:23.381Z")
@Stability(Stable)
public class DatabaseClusterEngine
extends software.amazon.jsii.JsiiObject

A database cluster engine.

Provides mapping to the serverless application used for secret rotation.

Example:

 Vpc vpc;
 DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "Database")
         .engine(DatabaseClusterEngine.auroraMysql(AuroraMysqlClusterEngineProps.builder().version(AuroraMysqlEngineVersion.VER_3_01_0).build()))
         .credentials(Credentials.fromGeneratedSecret("clusteradmin")) // Optional - will default to 'admin' username and generated password
         .writer(ClusterInstance.provisioned("writer", ProvisionedClusterInstanceProps.builder()
                 .publiclyAccessible(false)
                 .build()))
         .readers(List.of(ClusterInstance.provisioned("reader1", ProvisionedClusterInstanceProps.builder().promotionTier(1).build()), ClusterInstance.serverlessV2("reader2")))
         .vpcSubnets(SubnetSelection.builder()
                 .subnetType(SubnetType.PRIVATE_WITH_EGRESS)
                 .build())
         .vpc(vpc)
         .build();
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Field Summary

Fields

Modifier and Type	Field	Description
static final IClusterEngine	AURORA	The unversioned 'aurora' cluster engine.
static final IClusterEngine	AURORA_MYSQL	The unversioned 'aurora-msql' cluster engine.
static final IClusterEngine	AURORA_POSTGRESQL	The unversioned 'aurora-postgresql' cluster engine.

Constructor Summary

Constructors

Modifier	Constructor	Description
	DatabaseClusterEngine()
protected	DatabaseClusterEngine(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	DatabaseClusterEngine(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
static IClusterEngine	aurora(AuroraClusterEngineProps props)	Creates a new plain Aurora database cluster engine.
static IClusterEngine	auroraMysql(AuroraMysqlClusterEngineProps props)	Creates a new Aurora MySQL database cluster engine.
static IClusterEngine	auroraPostgres(AuroraPostgresClusterEngineProps props)	Creates a new Aurora PostgreSQL database cluster engine.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

AURORA

@Stability(Stable)
public static final IClusterEngine AURORA

The unversioned 'aurora' cluster engine.

Note: we do not recommend using unversioned engines for non-serverless Clusters, as that can pose an availability risk. We recommend using versioned engines created using the aurora() method

AURORA_MYSQL

@Stability(Stable)
public static final IClusterEngine AURORA_MYSQL

The unversioned 'aurora-msql' cluster engine.

Note: we do not recommend using unversioned engines for non-serverless Clusters, as that can pose an availability risk. We recommend using versioned engines created using the auroraMysql() method

AURORA_POSTGRESQL

@Stability(Stable)
public static final IClusterEngine AURORA_POSTGRESQL

The unversioned 'aurora-postgresql' cluster engine.

Note: we do not recommend using unversioned engines for non-serverless Clusters, as that can pose an availability risk. We recommend using versioned engines created using the auroraPostgres() method

Constructor Details

DatabaseClusterEngine

protected DatabaseClusterEngine(software.amazon.jsii.JsiiObjectRef objRef)

DatabaseClusterEngine

protected DatabaseClusterEngine(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

DatabaseClusterEngine

@Stability(Stable)
public DatabaseClusterEngine()

Method Details

aurora

@Stability(Stable)
@NotNull
public static IClusterEngine aurora(@NotNull
 AuroraClusterEngineProps props)

Creates a new plain Aurora database cluster engine.

Parameters:

props - This parameter is required.

auroraMysql

@Stability(Stable)
@NotNull
public static IClusterEngine auroraMysql(@NotNull
 AuroraMysqlClusterEngineProps props)

Creates a new Aurora MySQL database cluster engine.

Parameters:

props - This parameter is required.

auroraPostgres

@Stability(Stable)
@NotNull
public static IClusterEngine auroraPostgres(@NotNull
 AuroraPostgresClusterEngineProps props)

Creates a new Aurora PostgreSQL database cluster engine.

Parameters:

props - This parameter is required.